specs-sdk 1.3.0

data/lib/verizon/controllers/usage_trigger_management_controller.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # UsageTriggerManagementController
+  class UsageTriggerManagementController < BaseController
+    # Create a new usage trigger, which will send an alert when the number of
+    # device location service transactions reaches a specified percentage of the
+    # monthly subscription amount.
+    # @param [UsageTriggerAddRequest] body Optional parameter: License
+    # assignment.
+    # @return [UsageTriggerResponse] response from the API call
+    def create_new_trigger(body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/usage/triggers',
+                                     Server::SUBSCRIPTION_SERVER)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UsageTriggerResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error',
+                                DeviceLocationResultException))
+        .execute
+    end
+
+    # Update an existing usage trigger
+    # @param [String] trigger_id Required parameter: Usage trigger ID
+    # @param [UsageTriggerUpdateRequest] body Optional parameter: New trigger
+    # values
+    # @return [UsageTriggerResponse] response from the API call
+    def update_trigger(trigger_id,
+                       body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/usage/triggers/{triggerId}',
+                                     Server::SUBSCRIPTION_SERVER)
+                   .template_param(new_parameter(trigger_id, key: 'triggerId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UsageTriggerResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error',
+                                DeviceLocationResultException))
+        .execute
+    end
+
+    # eletes the specified usage trigger from the given account
+    # @param [String] account_name Required parameter: Account name
+    # @param [String] trigger_id Required parameter: Usage trigger ID
+    # @return [DeviceLocationSuccessResult] response from the API call
+    def delete_trigger(account_name,
+                       trigger_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/usage/accounts/{accountName}/triggers/{triggerId}',
+                                     Server::SUBSCRIPTION_SERVER)
+                   .template_param(new_parameter(account_name, key: 'accountName')
+                                    .should_encode(true))
+                   .template_param(new_parameter(trigger_id, key: 'triggerId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceLocationSuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error',
+                                DeviceLocationResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/wireless_network_performance_controller.rb

@@ -0,0 +1,132 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # WirelessNetworkPerformanceController
+  class WirelessNetworkPerformanceController < BaseController
+    # WNP Query for current network condition.
+    # @param [GetNetworkConditionsRequest] body Required parameter: Request for
+    # current network health.
+    # @return [WNPRequestResponse] response from the API call
+    def near_real_time_network_conditions(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/intelligence/network-conditions',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(WNPRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                WNPRestErrorResponseException))
+        .execute
+    end
+
+    # Run a report to determine network types available and available coverage.
+    # Network types covered include: CAT-M, NB-IOT, LTE, LTE-AWS and 5GNW.
+    # @param [GetWirelessCoverageRequest] body Required parameter: Request for
+    # network coverage details.
+    # @return [WNPRequestResponse] response from the API call
+    def domestic4g_and_5g_nationwide_network_coverage(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/intelligence/wireless-coverage',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(WNPRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                WNPRestErrorResponseException))
+        .execute
+    end
+
+    # Identify the direction and general distance of nearby cell sites and the
+    # technology supported by the equipment.
+    # @param [GetNetworkConditionsRequest] body Required parameter: Request for
+    # cell site proximity.
+    # @return [WNPRequestResponse] response from the API call
+    def site_proximity(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/intelligence/site-proximity/action/list',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(WNPRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                WNPRestErrorResponseException))
+        .execute
+    end
+
+    # A report of a specific device's service scores over a 30 day period.
+    # @param [GetDeviceExperienceScoreHistoryRequest] body Required parameter:
+    # Request for a device's 30 day experience.
+    # @return [WNPRequestResponse] response from the API call
+    def device_experience30days_history(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/intelligence/device-experience/history/30-days',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(WNPRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                WNPRestErrorResponseException))
+        .execute
+    end
+
+    # Run a report to view the latest device experience score for specific
+    # devices.
+    # @param [GetDeviceExperienceScoreBulkRequest] body Required parameter:
+    # Request for bulk latest history details.
+    # @return [WNPRequestResponse] response from the API call
+    def device_experience_bulk_latest(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/intelligence/device-experience/bulk/latest',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(WNPRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                WNPRestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/exceptions/api_exception.rb

@@ -0,0 +1,10 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+  end
+end

data/lib/verizon/exceptions/connectivity_management_result_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to errors.
+  class ConnectivityManagementResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of the error.
+    # @return [String]
+    attr_accessor :error_code
+
+    # Details of the error.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+    end
+  end
+end

data/lib/verizon/exceptions/default_response_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DefaultResponse class.
+  class DefaultResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+    end
+  end
+end

data/lib/verizon/exceptions/device_diagnostics_result_exception.rb

@@ -0,0 +1,39 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # All error messages are returned in this format. Error codes and messages are
+  # listed on the Error Codes page, along with explanations and suggestions for
+  # corrective actions.
+  class DeviceDiagnosticsResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Simple error code.
+    # @return [String]
+    attr_accessor :error_code
+
+    # Detailed error message.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
+    end
+  end
+end

data/lib/verizon/exceptions/device_location_result_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Will be empty if there was no error.
+  class DeviceLocationResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
+    end
+  end
+end

data/lib/verizon/exceptions/edge_discovery_result_exception.rb

@@ -0,0 +1,43 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Base type for all errors.
+  class EdgeDiscoveryResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP status code or status of response.
+    # @return [String]
+    attr_accessor :status
+
+    # Error details.
+    # @return [String]
+    attr_accessor :message
+
+    # For cases where user input exceeds the boundary values an additional
+    # 'data' key will be returned with a relevant description.
+    # @return [EdgeDiscoveryResultData]
+    attr_accessor :data
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @status = hash.key?('status') ? hash['status'] : nil
+      @message = hash.key?('message') ? hash['message'] : nil
+      @data = EdgeDiscoveryResultData.from_hash(hash['data']) if hash['data']
+    end
+  end
+end

data/lib/verizon/exceptions/edge_performance_result_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Types of errors in response.
+  class EdgePerformanceResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP status code.
+    # @return [String]
+    attr_accessor :status
+
+    # Error details.
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+    end
+  end
+end

data/lib/verizon/exceptions/esim_rest_error_response_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # eSIMRestErrorResponse class.
+  class ESIMRestErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+    end
+  end
+end

data/lib/verizon/exceptions/fota_v1_result_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response in case of any errors.
+  class FotaV1ResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error response code.
+    # @return [String]
+    attr_accessor :error_code
+
+    # Description of the error.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
+    end
+  end
+end

data/lib/verizon/exceptions/fota_v2_result_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response for error cases.
+  class FotaV2ResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of the error.
+    # @return [String]
+    attr_accessor :error_code
+
+    # Details of the error.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
+    end
+  end
+end

data/lib/verizon/exceptions/fota_v3_result_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Error response.
+  class FotaV3ResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code string.
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error message string.
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
+    end
+  end
+end

data/lib/verizon/exceptions/gio_rest_error_response_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # GIORestErrorResponse class.
+  class GIORestErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+    end
+  end
+end