specs-sdk 1.3.0

data/lib/verizon/exceptions/hyper_precise_location_result_exception.rb

@@ -0,0 +1,47 @@
+# 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
+
+    # Fault occurred while responding.
+    # @return [Object]
+    attr_accessor :example
+
+    # 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']
+      @example = hash.key?('example') ? hash['example'] : SKIP
+    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/oauth_provider_exception.rb

@@ -0,0 +1,48 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # OAuth 2 Authorization endpoint exception.
+  class OauthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OauthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # 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 = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+  end
+end

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/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/oauth_2.rb

@@ -0,0 +1,97 @@
+# 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 Oauth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'OAuth2: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(oauth_2credentials, config)
+      auth_params = {}
+      @_oauth_client_id = oauth_2credentials.oauth_client_id unless
+        oauth_2credentials.nil? || oauth_2credentials.oauth_client_id.nil?
+      @_oauth_client_secret = oauth_2credentials.oauth_client_secret unless
+        oauth_2credentials.nil? || oauth_2credentials.oauth_client_secret.nil?
+      @_oauth_token = oauth_2credentials.oauth_token unless
+        oauth_2credentials.nil? || oauth_2credentials.oauth_token.nil?
+      @_oauth_scopes = oauth_2credentials.oauth_scopes unless
+        oauth_2credentials.nil? || oauth_2credentials.oauth_scopes.nil?
+      @_o_auth_api = OauthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_oauth_token.access_token}" unless @_oauth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_oauth_token.nil? && !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_oauth_2(
+        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)
+    end
+  end
+
+  # Data class for OAuth2Credentials.
+  class OAuth2Credentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_token,
+                :oauth_scopes
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_token: nil,
+                   oauth_scopes: 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
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_token: nil, oauth_scopes: 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
+
+      OAuth2Credentials.new(oauth_client_id: oauth_client_id,
+                            oauth_client_secret: oauth_client_secret,
+                            oauth_token: oauth_token,
+                            oauth_scopes: oauth_scopes)
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# 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)
+      auth_params = {}
+      @_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?
+      @_o_auth_api = OauthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_oauth_token.access_token}" unless @_oauth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_oauth_token.nil? && !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,
+        _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)
+    end
+  end
+
+  # Data class for ThingspaceOauthCredentials.
+  class ThingspaceOauthCredentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_token
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_token: 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
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_token: nil)
+      oauth_client_id ||= self.oauth_client_id
+      oauth_client_secret ||= self.oauth_client_secret
+      oauth_token ||= self.oauth_token
+
+      ThingspaceOauthCredentials.new(oauth_client_id: oauth_client_id,
+                                     oauth_client_secret: oauth_client_secret,
+                                     oauth_token: oauth_token)
+    end
+  end
+end

data/lib/verizon/http/http_call_back.rb

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

data/lib/verizon/http/http_method_enum.rb

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

data/lib/verizon/http/http_request.rb

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

data/lib/verizon/http/http_response.rb

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

data/lib/verizon/models/acceleration.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Acceleration Model.
+  class Acceleration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :x
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :y
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :z
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['x'] = 'x'
+      @_hash['y'] = 'y'
+      @_hash['z'] = 'z'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        x
+        y
+        z
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(x = SKIP,
+                   y = SKIP,
+                   z = SKIP)
+      @x = x unless x == SKIP
+      @y = y unless y == SKIP
+      @z = z unless z == 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.
+      x = hash.key?('x') ? hash['x'] : SKIP
+      y = hash.key?('y') ? hash['y'] : SKIP
+      z = hash.key?('z') ? hash['z'] : SKIP
+
+      # Create object from extracted values.
+      Acceleration.new(x,
+                       y,
+                       z)
+    end
+  end
+end