sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

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

data/lib/verizon/exceptions/hyper_precise_location_result_exception.rb

@@ -0,0 +1,42 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Error response.
+  class HyperPreciseLocationResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error Code.
+    # @return [ErrorResponseCodeEnum]
+    attr_accessor :response_code
+
+    # Error message.
+    # @return [String]
+    attr_accessor :message
+
+    # Fault occurred while responding.
+    # @return [HyperPreciseLocationFault]
+    attr_accessor :fault
+
+    # 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)
+      @response_code = hash.key?('responseCode') ? hash['responseCode'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+      @fault = HyperPreciseLocationFault.from_hash(hash['fault']) if hash['fault']
+    end
+  end
+end

data/lib/verizon/exceptions/intelligence_result_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # An error occurred.
+  class IntelligenceResultException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 3-digit HTML error code.
+    # @return [String]
+    attr_accessor :error_code
+
+    # 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'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+    end
+  end
+end

data/lib/verizon/exceptions/m_5g_bi_rest_error_response_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # 5gbiRestErrorResponse class.
+  class M5gBiRestErrorResponseException < 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_thing_space_quality_of_service_api_endpoints/exceptions/o_auth_provider_exception.rb → verizon/exceptions/oauth_provider_exception.rb}

@@ -1,16 +1,16 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # OAuth 2 Authorization endpoint exception.
-  class OAuthProviderException < APIException
+  class OauthProviderException < APIException
     SKIP = Object.new
     private_constant :SKIP
 
     # Gets or sets error code.
-    # @return [OAuthProviderErrorEnum]
+    # @return [OauthProviderErrorEnum]
     attr_accessor :error
 
     # Gets or sets human-readable text providing additional information on

data/lib/verizon/exceptions/ready_sim_rest_error_response_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ReadySimRestErrorResponse class.
+  class ReadySimRestErrorResponseException < 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/rest_error_response_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # RestErrorResponse class.
+  class RestErrorResponseException < 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/rules_engine_rest_error_response_exception.rb

@@ -0,0 +1,42 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # RulesEngineRestErrorResponse class.
+  class RulesEngineRestErrorResponseException < 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
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_url
+
+    # 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
+      @error_url = hash.key?('errorUrl') ? hash['errorUrl'] : SKIP
+    end
+  end
+end

data/lib/verizon/exceptions/security_result_exception.rb

@@ -0,0 +1,42 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Error response.
+  class SecurityResultException < 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
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_url
+
+    # 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
+      @error_url = hash.key?('errorUrl') ? hash['errorUrl'] : SKIP
+    end
+  end
+end

data/lib/verizon/exceptions/wnp_rest_error_response_exception.rb

@@ -0,0 +1,37 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Wireless network performance rest error response.
+  class WNPRestErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Rest error response.
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error message details.
+    # @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/http/api_response.rb

@@ -0,0 +1,21 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+
+
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/verizon/http/auth/thingspace_oauth.rb

@@ -0,0 +1,140 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Utility class for OAuth 2 authorization and token management.
+  class ThingspaceOauth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ThingspaceOauth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(thingspace_oauth_credentials, config)
+      @_oauth_client_id = thingspace_oauth_credentials.oauth_client_id unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_client_id.nil?
+      @_oauth_client_secret = thingspace_oauth_credentials.oauth_client_secret unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_client_secret.nil?
+      @_oauth_token = thingspace_oauth_credentials.oauth_token unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_token.nil?
+      @_oauth_scopes = thingspace_oauth_credentials.oauth_scopes unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_scopes.nil?
+      @_oauth_clock_skew = thingspace_oauth_credentials.oauth_clock_skew unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_clock_skew.nil?
+      @_oauth_token_provider = thingspace_oauth_credentials.oauth_token_provider unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_token_provider.nil?
+      @_oauth_on_token_update = thingspace_oauth_credentials.oauth_on_token_update unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_on_token_update.nil?
+      @_o_auth_api = OauthAuthorizationController.new(config)
+      super({})
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      @_oauth_token = get_token_from_provider
+      @_oauth_token.is_a?(OAuthToken) && !token_expired?(@_oauth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_oauth_client_id, @_oauth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token_thingspace_oauth(
+        build_basic_auth_header,
+        scope: !@_oauth_scopes.nil? ? Array(@_oauth_scopes).compact.join(' ') : @_oauth_scopes,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry, @_oauth_clock_skew)
+    end
+
+    def apply(http_request)
+      auth_params = { 'Authorization' => "Bearer #{@_oauth_token.access_token}" }
+      AuthHelper.apply(auth_params, http_request.method(:add_header))
+    end
+
+    private
+
+    # This provides the OAuth Token from either the user configured callbacks or from default provider.
+    # @return [OAuthToken] The fetched oauth token.
+    def get_token_from_provider
+      return @_oauth_token if @_oauth_token && !token_expired?(@_oauth_token)
+
+      if @_o_auth_token_provider
+        o_auth_token = @_o_auth_token_provider.call(@_oauth_token, self)
+        @_o_auth_on_token_update&.call(o_auth_token)
+        return o_auth_token
+      end
+      begin
+        o_auth_token = fetch_token
+        @_o_auth_on_token_update&.call(o_auth_token)
+        o_auth_token
+      rescue ApiException
+        @_o_auth_token
+      end
+    end
+  end
+
+  # Data class for ThingspaceOauthCredentials.
+  class ThingspaceOauthCredentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_token,
+                :oauth_scopes, :oauth_token_provider, :oauth_on_token_update,
+                :oauth_clock_skew
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_token: nil,
+                   oauth_scopes: nil, oauth_token_provider: nil,
+                   oauth_on_token_update: nil, oauth_clock_skew: nil)
+      raise ArgumentError, 'oauth_client_id cannot be nil' if oauth_client_id.nil?
+      raise ArgumentError, 'oauth_client_secret cannot be nil' if oauth_client_secret.nil?
+
+      @oauth_client_id = oauth_client_id
+      @oauth_client_secret = oauth_client_secret
+      @oauth_token = oauth_token
+      @oauth_scopes = oauth_scopes
+      @oauth_token_provider = oauth_token_provider
+      @oauth_on_token_update = oauth_on_token_update
+      @oauth_clock_skew = oauth_clock_skew
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_token: nil, oauth_scopes: nil,
+                   oauth_token_provider: nil, oauth_on_token_update: nil,
+                   oauth_clock_skew: nil)
+      oauth_client_id ||= self.oauth_client_id
+      oauth_client_secret ||= self.oauth_client_secret
+      oauth_token ||= self.oauth_token
+      oauth_scopes ||= self.oauth_scopes
+      oauth_token_provider ||= self.oauth_token_provider
+      oauth_on_token_update ||= self.oauth_on_token_update
+      oauth_clock_skew ||= self.oauth_clock_skew
+
+      ThingspaceOauthCredentials.new(
+        oauth_client_id: oauth_client_id,
+        oauth_client_secret: oauth_client_secret, oauth_token: oauth_token,
+        oauth_scopes: oauth_scopes, oauth_token_provider: oauth_token_provider,
+        oauth_on_token_update: oauth_on_token_update,
+        oauth_clock_skew: oauth_clock_skew
+      )
+    end
+  end
+end

data/lib/verizon/http/auth/vz_m2m_token.rb

@@ -0,0 +1,42 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Utility class for custom header authorization.
+  class VzM2mToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'VZM2MToken: vz_m2m_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(vz_m2m_token_credentials)
+      auth_params = {}
+      auth_params['VZ-M2M-Token'] = vz_m2m_token_credentials.vz_m2m_token unless
+        vz_m2m_token_credentials.nil? || vz_m2m_token_credentials.vz_m2m_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for VZM2MTokenCredentials.
+  # Data class for VZM2MTokenCredentials.
+  class VZM2MTokenCredentials
+    attr_reader :vz_m2m_token
+
+    def initialize(vz_m2m_token:)
+      raise ArgumentError, 'vz_m2m_token cannot be nil' if vz_m2m_token.nil?
+
+      @vz_m2m_token = vz_m2m_token
+    end
+
+    def clone_with(vz_m2m_token: nil)
+      vz_m2m_token ||= self.vz_m2m_token
+
+      VZM2MTokenCredentials.new(vz_m2m_token: vz_m2m_token)
+    end
+  end
+end

data/lib/{verizon_thing_space_quality_of_service_api_endpoints → verizon}/http/http_call_back.rb

@@ -1,9 +1,9 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # HttpCallBack allows defining callables for pre and post API calls.
   class HttpCallBack < CoreLibrary::HttpCallback
   end

data/lib/{verizon_thing_space_quality_of_service_api_endpoints → verizon}/http/http_method_enum.rb

@@ -1,9 +1,9 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # HTTP Methods Enumeration.
   class HttpMethodEnum < CoreLibrary::HttpMethod
   end

data/lib/{verizon_thing_space_quality_of_service_api_endpoints → verizon}/http/http_request.rb

@@ -1,9 +1,9 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # Represents a single Http Request.
   class HttpRequest < CoreLibrary::HttpRequest
   end

data/lib/{verizon_thing_space_quality_of_service_api_endpoints → verizon}/http/http_response.rb

@@ -1,9 +1,9 @@
-# verizon_thing_space_quality_of_service_api_endpoints
+# verizon
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module VerizonThingSpaceQualityOfServiceApiEndpoints
+module Verizon
   # Http response received.
   class HttpResponse < CoreLibrary::HttpResponse
   end