specs-sdk 1.3.0

data/lib/verizon/models/resource_identifier.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The ID of the target to delete, in the format {"id":
+  # "dd1682d3-2d80-cefc-f3ee-25154800beff"}.
+  class ResourceIdentifier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Target ID.
+    # @return [String]
+    attr_accessor :id
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :imei
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['imei'] = 'imei'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        imei
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   imei = SKIP)
+      @id = id unless id == SKIP
+      @imei = imei unless imei == 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
+      imei = hash.key?('imei') ? hash['imei'] : SKIP
+
+      # Create object from extracted values.
+      ResourceIdentifier.new(id,
+                             imei)
+    end
+  end
+end

data/lib/verizon/models/resources_edge_hosted_service.rb

@@ -0,0 +1,96 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Edge hosted service represented by Service Endpoint definition.
+  class ResourcesEdgeHostedService < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Edge Resource Name. A string identifier for a set of edge resources.
+    # @return [String]
+    attr_accessor :ern
+
+    # Service Endpoint path, address, and port.
+    # @return [ResourcesServiceEndpoint]
+    attr_accessor :service_endpoint
+
+    # Unique ID representing the Edge Application Provider.
+    # @return [String]
+    attr_accessor :application_server_provider_id
+
+    # Unique ID representing the Edge Application.
+    # @return [String]
+    attr_accessor :application_id
+
+    # Unique ID representing the Edge Application.
+    # @return [String]
+    attr_accessor :service_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ern'] = 'ern'
+      @_hash['service_endpoint'] = 'serviceEndpoint'
+      @_hash['application_server_provider_id'] = 'applicationServerProviderId'
+      @_hash['application_id'] = 'applicationId'
+      @_hash['service_description'] = 'serviceDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ern
+        service_endpoint
+        application_server_provider_id
+        application_id
+        service_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ern = SKIP,
+                   service_endpoint = SKIP,
+                   application_server_provider_id = SKIP,
+                   application_id = SKIP,
+                   service_description = SKIP)
+      @ern = ern unless ern == SKIP
+      @service_endpoint = service_endpoint unless service_endpoint == SKIP
+      unless application_server_provider_id == SKIP
+        @application_server_provider_id =
+          application_server_provider_id
+      end
+      @application_id = application_id unless application_id == SKIP
+      @service_description = service_description unless service_description == 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
+      service_endpoint = ResourcesServiceEndpoint.from_hash(hash['serviceEndpoint']) if
+        hash['serviceEndpoint']
+      application_server_provider_id =
+        hash.key?('applicationServerProviderId') ? hash['applicationServerProviderId'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      service_description =
+        hash.key?('serviceDescription') ? hash['serviceDescription'] : SKIP
+
+      # Create object from extracted values.
+      ResourcesEdgeHostedService.new(ern,
+                                     service_endpoint,
+                                     application_server_provider_id,
+                                     application_id,
+                                     service_description)
+    end
+  end
+end

data/lib/verizon/models/resources_edge_hosted_service_with_profile_id.rb

@@ -0,0 +1,107 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Edge hosted service represented by Service Endpoint definition.
+  class ResourcesEdgeHostedServiceWithProfileId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Edge Resource Name. A string identifier for a set of edge resources.
+    # @return [String]
+    attr_accessor :ern
+
+    # Service Endpoint path, address, and port.
+    # @return [ResourcesServiceEndpoint]
+    attr_accessor :service_endpoint
+
+    # Unique ID representing the Edge Application Provider.
+    # @return [String]
+    attr_accessor :application_server_provider_id
+
+    # Unique ID representing the Edge Application.
+    # @return [String]
+    attr_accessor :application_id
+
+    # Unique ID representing the Edge Application.
+    # @return [String]
+    attr_accessor :service_description
+
+    # The system assigned ID of the service profile.
+    # @return [String]
+    attr_accessor :service_profile_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ern'] = 'ern'
+      @_hash['service_endpoint'] = 'serviceEndpoint'
+      @_hash['application_server_provider_id'] = 'applicationServerProviderId'
+      @_hash['application_id'] = 'applicationId'
+      @_hash['service_description'] = 'serviceDescription'
+      @_hash['service_profile_id'] = 'serviceProfileID'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ern
+        service_endpoint
+        application_server_provider_id
+        application_id
+        service_description
+        service_profile_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ern = SKIP,
+                   service_endpoint = SKIP,
+                   application_server_provider_id = SKIP,
+                   application_id = SKIP,
+                   service_description = SKIP,
+                   service_profile_id = SKIP)
+      @ern = ern unless ern == SKIP
+      @service_endpoint = service_endpoint unless service_endpoint == SKIP
+      unless application_server_provider_id == SKIP
+        @application_server_provider_id =
+          application_server_provider_id
+      end
+      @application_id = application_id unless application_id == SKIP
+      @service_description = service_description unless service_description == SKIP
+      @service_profile_id = service_profile_id unless service_profile_id == 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
+      service_endpoint = ResourcesServiceEndpoint.from_hash(hash['serviceEndpoint']) if
+        hash['serviceEndpoint']
+      application_server_provider_id =
+        hash.key?('applicationServerProviderId') ? hash['applicationServerProviderId'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      service_description =
+        hash.key?('serviceDescription') ? hash['serviceDescription'] : SKIP
+      service_profile_id =
+        hash.key?('serviceProfileID') ? hash['serviceProfileID'] : SKIP
+
+      # Create object from extracted values.
+      ResourcesEdgeHostedServiceWithProfileId.new(ern,
+                                                  service_endpoint,
+                                                  application_server_provider_id,
+                                                  application_id,
+                                                  service_description,
+                                                  service_profile_id)
+    end
+  end
+end

data/lib/verizon/models/resources_service_endpoint.rb

@@ -0,0 +1,90 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Service Endpoint path, address, and port.
+  class ResourcesServiceEndpoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URI of Service Endpoint if available.
+    # @return [String]
+    attr_accessor :uri
+
+    # FQDN of Service Endpoint if available.
+    # @return [String]
+    attr_accessor :fqdn
+
+    # IPv4 Address of Service Endpoint if available.
+    # @return [String]
+    attr_accessor :i_pv4_address
+
+    # IPv6 Address of Service Endpoint if available.
+    # @return [String]
+    attr_accessor :i_pv6_address
+
+    # Port information of Service Endpoint if IPv4 or IPv6 is mentioned.
+    # @return [Integer]
+    attr_accessor :port
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uri'] = 'URI'
+      @_hash['fqdn'] = 'FQDN'
+      @_hash['i_pv4_address'] = 'IPv4Address'
+      @_hash['i_pv6_address'] = 'IPv6Address'
+      @_hash['port'] = 'port'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uri
+        fqdn
+        i_pv4_address
+        i_pv6_address
+        port
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uri = SKIP,
+                   fqdn = SKIP,
+                   i_pv4_address = SKIP,
+                   i_pv6_address = SKIP,
+                   port = SKIP)
+      @uri = uri unless uri == SKIP
+      @fqdn = fqdn unless fqdn == SKIP
+      @i_pv4_address = i_pv4_address unless i_pv4_address == SKIP
+      @i_pv6_address = i_pv6_address unless i_pv6_address == SKIP
+      @port = port unless port == 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.
+      uri = hash.key?('URI') ? hash['URI'] : SKIP
+      fqdn = hash.key?('FQDN') ? hash['FQDN'] : SKIP
+      i_pv4_address = hash.key?('IPv4Address') ? hash['IPv4Address'] : SKIP
+      i_pv6_address = hash.key?('IPv6Address') ? hash['IPv6Address'] : SKIP
+      port = hash.key?('port') ? hash['port'] : SKIP
+
+      # Create object from extracted values.
+      ResourcesServiceEndpoint.new(uri,
+                                   fqdn,
+                                   i_pv4_address,
+                                   i_pv6_address,
+                                   port)
+    end
+  end
+end

data/lib/verizon/models/resources_service_profile.rb

@@ -0,0 +1,119 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Information about the resource requirements and service characteristics of
+  # an edge application. The `maxLatencyMs` and `clientType` parameters are both
+  # required in the request body. **Note:** The `maxLatencyMs` value must be
+  # submitted in multiples of 5. Does not include serviceProfileId
+  class ResourcesServiceProfile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The category of application client.
+    # @return [ClientTypeEnum]
+    attr_accessor :client_type
+
+    # Identity of the preferred Edge Computing Service Provider.
+    # @return [String]
+    attr_accessor :ecsp_filter
+
+    # The expected operation schedule of the application client (e.g. time
+    # windows).
+    # @return [String]
+    attr_accessor :client_schedule
+
+    # The expected location(s) (e.g. route) of the hosting UE during the
+    # Client's operation schedule.
+    # @return [String]
+    attr_accessor :client_service_area
+
+    # Network resources of a service profile.
+    # @return [NetworkResourcesType]
+    attr_accessor :network_resources
+
+    # Compute resources of a service profile.
+    # @return [ComputeResourcesType]
+    attr_accessor :compute_resources
+
+    # Additional service support information for the MEC platform.
+    # @return [MECPlatformsAdditionalSupportInfo]
+    attr_accessor :properties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_type'] = 'clientType'
+      @_hash['ecsp_filter'] = 'ecspFilter'
+      @_hash['client_schedule'] = 'clientSchedule'
+      @_hash['client_service_area'] = 'clientServiceArea'
+      @_hash['network_resources'] = 'networkResources'
+      @_hash['compute_resources'] = 'computeResources'
+      @_hash['properties'] = 'properties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ecsp_filter
+        client_schedule
+        client_service_area
+        network_resources
+        compute_resources
+        properties
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_type = nil,
+                   ecsp_filter = SKIP,
+                   client_schedule = SKIP,
+                   client_service_area = SKIP,
+                   network_resources = SKIP,
+                   compute_resources = SKIP,
+                   properties = SKIP)
+      @client_type = client_type
+      @ecsp_filter = ecsp_filter unless ecsp_filter == SKIP
+      @client_schedule = client_schedule unless client_schedule == SKIP
+      @client_service_area = client_service_area unless client_service_area == SKIP
+      @network_resources = network_resources unless network_resources == SKIP
+      @compute_resources = compute_resources unless compute_resources == 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.
+      client_type = hash.key?('clientType') ? hash['clientType'] : nil
+      ecsp_filter = hash.key?('ecspFilter') ? hash['ecspFilter'] : SKIP
+      client_schedule =
+        hash.key?('clientSchedule') ? hash['clientSchedule'] : SKIP
+      client_service_area =
+        hash.key?('clientServiceArea') ? hash['clientServiceArea'] : SKIP
+      network_resources = NetworkResourcesType.from_hash(hash['networkResources']) if
+        hash['networkResources']
+      compute_resources = ComputeResourcesType.from_hash(hash['computeResources']) if
+        hash['computeResources']
+      properties = MECPlatformsAdditionalSupportInfo.from_hash(hash['properties']) if
+        hash['properties']
+
+      # Create object from extracted values.
+      ResourcesServiceProfile.new(client_type,
+                                  ecsp_filter,
+                                  client_schedule,
+                                  client_service_area,
+                                  network_resources,
+                                  compute_resources,
+                                  properties)
+    end
+  end
+end

data/lib/verizon/models/resources_service_profile_with_id.rb

@@ -0,0 +1,129 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Information about the resource requirements and service characteristics of
+  # an edge application. Includes serviceProfileId. Used when retrieving a
+  # service profile.
+  class ResourcesServiceProfileWithId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for a service profile.
+    # @return [String]
+    attr_accessor :service_profile_id
+
+    # The category of application client.
+    # @return [ClientTypeEnum]
+    attr_accessor :client_type
+
+    # Identity of the preferred Edge Computing Service Provider.
+    # @return [String]
+    attr_accessor :ecsp_filter
+
+    # The expected operation schedule of the application client (e.g. time
+    # windows).
+    # @return [String]
+    attr_accessor :client_schedule
+
+    # The expected location(s) (e.g. route) of the hosting UE during the
+    # Client's operation schedule.
+    # @return [String]
+    attr_accessor :client_service_area
+
+    # Network resources of a service profile.
+    # @return [NetworkResourcesType]
+    attr_accessor :network_resources
+
+    # Compute resources of a service profile.
+    # @return [ComputeResourcesType]
+    attr_accessor :compute_resources
+
+    # Additional service support information for the MEC platform.
+    # @return [MECPlatformsAdditionalSupportInfo]
+    attr_accessor :properties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_profile_id'] = 'serviceProfileId'
+      @_hash['client_type'] = 'clientType'
+      @_hash['ecsp_filter'] = 'ecspFilter'
+      @_hash['client_schedule'] = 'clientSchedule'
+      @_hash['client_service_area'] = 'clientServiceArea'
+      @_hash['network_resources'] = 'networkResources'
+      @_hash['compute_resources'] = 'computeResources'
+      @_hash['properties'] = 'properties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        service_profile_id
+        ecsp_filter
+        client_schedule
+        client_service_area
+        network_resources
+        compute_resources
+        properties
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_type = nil,
+                   service_profile_id = SKIP,
+                   ecsp_filter = SKIP,
+                   client_schedule = SKIP,
+                   client_service_area = SKIP,
+                   network_resources = SKIP,
+                   compute_resources = SKIP,
+                   properties = SKIP)
+      @service_profile_id = service_profile_id unless service_profile_id == SKIP
+      @client_type = client_type
+      @ecsp_filter = ecsp_filter unless ecsp_filter == SKIP
+      @client_schedule = client_schedule unless client_schedule == SKIP
+      @client_service_area = client_service_area unless client_service_area == SKIP
+      @network_resources = network_resources unless network_resources == SKIP
+      @compute_resources = compute_resources unless compute_resources == 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.
+      client_type = hash.key?('clientType') ? hash['clientType'] : nil
+      service_profile_id =
+        hash.key?('serviceProfileId') ? hash['serviceProfileId'] : SKIP
+      ecsp_filter = hash.key?('ecspFilter') ? hash['ecspFilter'] : SKIP
+      client_schedule =
+        hash.key?('clientSchedule') ? hash['clientSchedule'] : SKIP
+      client_service_area =
+        hash.key?('clientServiceArea') ? hash['clientServiceArea'] : SKIP
+      network_resources = NetworkResourcesType.from_hash(hash['networkResources']) if
+        hash['networkResources']
+      compute_resources = ComputeResourcesType.from_hash(hash['computeResources']) if
+        hash['computeResources']
+      properties = MECPlatformsAdditionalSupportInfo.from_hash(hash['properties']) if
+        hash['properties']
+
+      # Create object from extracted values.
+      ResourcesServiceProfileWithId.new(client_type,
+                                        service_profile_id,
+                                        ecsp_filter,
+                                        client_schedule,
+                                        client_service_area,
+                                        network_resources,
+                                        compute_resources,
+                                        properties)
+    end
+  end
+end

data/lib/verizon/models/response_code_enum.rb

@@ -0,0 +1,29 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Possible response codes.
+  class ResponseCodeEnum
+    RESPONSE_CODE_ENUM = [
+      # TODO: Write general description for INVALID_ACCESS
+      INVALID_ACCESS = 'INVALID_ACCESS'.freeze,
+
+      # TODO: Write general description for INVALID_PARAMETER
+      INVALID_PARAMETER = 'INVALID_PARAMETER'.freeze,
+
+      # TODO: Write general description for INTERNAL_ERROR
+      INTERNAL_ERROR = 'INTERNAL_ERROR'.freeze,
+
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'SUCCESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESPONSE_CODE_ENUM.include?(value)
+    end
+  end
+end