sdksio-verizon-apis-sdk 1.5.1 → 1.6.0

data/lib/{verizon/exceptions/m_5g_bi_rest_error_response_exception.rb → verizon_thing_space_quality_of_service_api_endpoints/exceptions/default_exception.rb}

@@ -1,11 +1,11 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
-  # 5gbiRestErrorResponse class.
-  class M5gBiRestErrorResponseException < APIException
+module VerizonThingSpaceQualityOfServiceApiEndpoints
+  # default class.
+  class DefaultException < APIException
     SKIP = Object.new
     private_constant :SKIP
 

data/lib/{verizon → verizon_thing_space_quality_of_service_api_endpoints}/exceptions/device_location_result_exception.rb

@@ -1,9 +1,9 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # Will be empty if there was no error.
   class DeviceLocationResultException < APIException
     SKIP = Object.new

data/lib/{verizon/exceptions/oauth_provider_exception.rb → verizon_thing_space_quality_of_service_api_endpoints/exceptions/o_auth_provider_exception.rb}

@@ -1,16 +1,16 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # 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_thing_space_quality_of_service_api_endpoints/http/auth/thingspace_oauth.rb

@@ -0,0 +1,134 @@
+# verizon_thing_space_quality_of_service_api_endpoints
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module VerizonThingSpaceQualityOfServiceApiEndpoints
+  # 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)
+      @_o_auth_client_id = thingspace_oauth_credentials.o_auth_client_id unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = thingspace_oauth_credentials.o_auth_client_secret unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.o_auth_client_secret.nil?
+      @_o_auth_token = thingspace_oauth_credentials.o_auth_token unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.o_auth_token.nil?
+      @_o_auth_clock_skew = thingspace_oauth_credentials.o_auth_clock_skew unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.o_auth_clock_skew.nil?
+      @_o_auth_token_provider = thingspace_oauth_credentials.o_auth_token_provider unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.o_auth_token_provider.nil?
+      @_o_auth_on_token_update = thingspace_oauth_credentials.o_auth_on_token_update unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.o_auth_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
+      @_o_auth_token = get_token_from_provider
+      @_o_auth_token.is_a?(OAuthToken) && !token_expired?(@_o_auth_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(@_o_auth_client_id, @_o_auth_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
+      )
+      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, @_o_auth_clock_skew)
+    end
+
+    def apply(http_request)
+      auth_params = { 'Authorization' => "Bearer #{@_o_auth_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 @_o_auth_token if @_o_auth_token && !token_expired?(@_o_auth_token)
+
+      if @_o_auth_token_provider
+        o_auth_token = @_o_auth_token_provider.call(@_o_auth_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 :o_auth_client_id, :o_auth_client_secret, :o_auth_token,
+                :o_auth_token_provider, :o_auth_on_token_update,
+                :o_auth_clock_skew
+
+    def initialize(o_auth_client_id:, o_auth_client_secret:, o_auth_token: nil,
+                   o_auth_token_provider: nil, o_auth_on_token_update: nil,
+                   o_auth_clock_skew: nil)
+      raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
+      raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
+
+      @o_auth_client_id = o_auth_client_id
+      @o_auth_client_secret = o_auth_client_secret
+      @o_auth_token = o_auth_token
+      @o_auth_token_provider = o_auth_token_provider
+      @o_auth_on_token_update = o_auth_on_token_update
+      @o_auth_clock_skew = o_auth_clock_skew
+    end
+
+    def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_token: nil, o_auth_token_provider: nil,
+                   o_auth_on_token_update: nil, o_auth_clock_skew: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_client_secret ||= self.o_auth_client_secret
+      o_auth_token ||= self.o_auth_token
+      o_auth_token_provider ||= self.o_auth_token_provider
+      o_auth_on_token_update ||= self.o_auth_on_token_update
+      o_auth_clock_skew ||= self.o_auth_clock_skew
+
+      ThingspaceOauthCredentials.new(
+        o_auth_client_id: o_auth_client_id,
+        o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token,
+        o_auth_token_provider: o_auth_token_provider,
+        o_auth_on_token_update: o_auth_on_token_update,
+        o_auth_clock_skew: o_auth_clock_skew
+      )
+    end
+  end
+end

data/lib/verizon_thing_space_quality_of_service_api_endpoints/http/auth/vz_m2m_session_token.rb

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

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

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

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

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

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

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

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

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

data/lib/{verizon → verizon_thing_space_quality_of_service_api_endpoints}/models/account_consent_create.rb

@@ -1,9 +1,9 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # AccountConsentCreate Model.
   class AccountConsentCreate < BaseModel
     SKIP = Object.new
@@ -13,15 +13,10 @@ module Verizon
     # @return [Array[Object]]
     attr_accessor :device_list
 
-    # The numeric name of the account, including leading zeros.
-    # @return [String]
-    attr_accessor :account_name
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['device_list'] = 'deviceList'
-      @_hash['account_name'] = 'accountName'
       @_hash
     end
 
@@ -29,7 +24,6 @@ module Verizon
     def self.optionals
       %w[
         device_list
-        account_name
       ]
     end
 
@@ -38,9 +32,8 @@ module Verizon
       []
     end
 
-    def initialize(device_list = SKIP, account_name = SKIP)
+    def initialize(device_list = SKIP)
       @device_list = device_list unless device_list == SKIP
-      @account_name = account_name unless account_name == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +42,9 @@ module Verizon
 
       # Extract variables from the hash.
       device_list = hash.key?('deviceList') ? hash['deviceList'] : SKIP
-      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
 
       # Create object from extracted values.
-      AccountConsentCreate.new(device_list,
-                               account_name)
+      AccountConsentCreate.new(device_list)
     end
   end
 end

data/lib/{verizon → verizon_thing_space_quality_of_service_api_endpoints}/models/base_model.rb

@@ -1,9 +1,9 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # Base model.
   class BaseModel < CoreLibrary::BaseModel
     # Returns a Hash representation of the current object.

data/lib/{verizon → verizon_thing_space_quality_of_service_api_endpoints}/models/consent_transaction_id.rb

@@ -1,11 +1,11 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
-  # The transaction ID of the request that you want to cancel, from the POST
-  # /devicelocations synchronus response.
+module VerizonThingSpaceQualityOfServiceApiEndpoints
+  # The transaction ID of the request, from the POST /devicelocations
+  # synchronous response.
   class ConsentTransactionID < BaseModel
     SKIP = Object.new
     private_constant :SKIP

data/lib/{verizon/models/esim_device_id.rb → verizon_thing_space_quality_of_service_api_endpoints/models/device_id.rb}

@@ -1,19 +1,21 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
-  # ESIMDeviceId Model.
-  class ESIMDeviceId < BaseModel
+module VerizonThingSpaceQualityOfServiceApiEndpoints
+  # device identifiers consisting of an ID value and what that value represents
+  # (kind)
+  class DeviceId < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # TODO: Write general description for this method
+    # The numeric or alphanumeric ID value
     # @return [String]
     attr_accessor :id
 
-    # TODO: Write general description for this method
+    # What the ID value represents, which could be a Mobile Directory Number
+    # (MDN) or an International Mobile Equipment Identifier (IMEI) as an example
     # @return [String]
     attr_accessor :kind
 
@@ -52,8 +54,8 @@ module Verizon
       kind = hash.key?('kind') ? hash['kind'] : SKIP
 
       # Create object from extracted values.
-      ESIMDeviceId.new(id,
-                       kind)
+      DeviceId.new(id,
+                   kind)
     end
   end
 end

data/lib/{verizon/models/qos_device_info.rb → verizon_thing_space_quality_of_service_api_endpoints/models/device_info.rb}

@@ -1,23 +1,24 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
-  # QosDeviceInfo Model.
-  class QosDeviceInfo < BaseModel
+module VerizonThingSpaceQualityOfServiceApiEndpoints
+  # DeviceInfo Model.
+  class DeviceInfo < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # TODO: Write general description for this method
-    # @return [QosDeviceId]
+    # device identifiers consisting of an ID value and what that value
+    # represents (kind)
+    # @return [DeviceId]
     attr_accessor :device_id
 
-    # TODO: Write general description for this method
+    # the IPv6 IP address of the device
     # @return [String]
     attr_accessor :device_i_pv6_addr
 
-    # TODO: Write general description for this method
+    # The details of the data connection
     # @return [Array[FlowInfo]]
     attr_accessor :flow_info
 
@@ -33,7 +34,9 @@ module Verizon
     # An array for optional fields
     def self.optionals
       %w[
+        device_id
         device_i_pv6_addr
+        flow_info
       ]
     end
 
@@ -42,10 +45,10 @@ module Verizon
       []
     end
 
-    def initialize(device_id = nil, flow_info = nil, device_i_pv6_addr = SKIP)
-      @device_id = device_id
+    def initialize(device_id = SKIP, device_i_pv6_addr = SKIP, flow_info = SKIP)
+      @device_id = device_id unless device_id == SKIP
       @device_i_pv6_addr = device_i_pv6_addr unless device_i_pv6_addr == SKIP
-      @flow_info = flow_info
+      @flow_info = flow_info unless flow_info == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -53,7 +56,9 @@ module Verizon
       return nil unless hash
 
       # Extract variables from the hash.
-      device_id = QosDeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      device_id = DeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      device_i_pv6_addr =
+        hash.key?('deviceIPv6Addr') ? hash['deviceIPv6Addr'] : SKIP
       # Parameter is an array, so we need to iterate through it
       flow_info = nil
       unless hash['flowInfo'].nil?
@@ -63,14 +68,12 @@ module Verizon
         end
       end
 
-      flow_info = nil unless hash.key?('flowInfo')
-      device_i_pv6_addr =
-        hash.key?('deviceIPv6Addr') ? hash['deviceIPv6Addr'] : SKIP
+      flow_info = SKIP unless hash.key?('flowInfo')
 
       # Create object from extracted values.
-      QosDeviceInfo.new(device_id,
-                        flow_info,
-                        device_i_pv6_addr)
+      DeviceInfo.new(device_id,
+                     device_i_pv6_addr,
+                     flow_info)
     end
   end
 end

data/lib/{verizon → verizon_thing_space_quality_of_service_api_endpoints}/models/flow_info.rb

@@ -1,31 +1,32 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # FlowInfo Model.
   class FlowInfo < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
-    # TODO: Write general description for this method
+    # The IPv6 IP address and port used to connect to the server
     # @return [String]
     attr_accessor :flow_server
 
-    # TODO: Write general description for this method
+    # The IPv6 IP address and port used by the device
     # @return [String]
     attr_accessor :flow_device
 
-    # TODO: Write general description for this method
+    # The direction the data is flowing. UPLINK if from the device, DOWNLINK is
+    # to the device
     # @return [String]
     attr_accessor :flow_direction
 
-    # TODO: Write general description for this method
+    # The data protocol used for the connection
     # @return [String]
     attr_accessor :flow_protocol
 
-    # TODO: Write general description for this method
+    # The QoS level of the connection. This will be Standard or Premium
     # @return [String]
     attr_accessor :qci_option
 

data/lib/{verizon → verizon_thing_space_quality_of_service_api_endpoints}/models/m201success.rb

@@ -1,9 +1,9 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # M201success Model.
   class M201success < BaseModel
     SKIP = Object.new

data/lib/{verizon/models/oauth_provider_error_enum.rb → verizon_thing_space_quality_of_service_api_endpoints/models/o_auth_provider_error_enum.rb}

@@ -1,12 +1,12 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # OAuth 2 Authorization error codes
-  class OauthProviderErrorEnum
-    OAUTH_PROVIDER_ERROR_ENUM = [
+  class OAuthProviderErrorEnum
+    O_AUTH_PROVIDER_ERROR_ENUM = [
       # The request is missing a required parameter, includes an unsupported
       # parameter value (other than grant type), repeats a parameter, includes
       # multiple credentials, utilizes more than one mechanism for
@@ -39,7 +39,7 @@ module Verizon
     def self.validate(value)
       return false if value.nil?
 
-      OAUTH_PROVIDER_ERROR_ENUM.include?(value)
+      O_AUTH_PROVIDER_ERROR_ENUM.include?(value)
     end
   end
 end

data/lib/{verizon/models/oauth_token.rb → verizon_thing_space_quality_of_service_api_endpoints/models/o_auth_token.rb}

@@ -1,11 +1,11 @@
-# verizon
+# verizon_thing_space_quality_of_service_api_endpoints
 #
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-module Verizon
+module VerizonThingSpaceQualityOfServiceApiEndpoints
   # OAuth 2 Authorization endpoint response
-  class OauthToken < BaseModel
+  class OAuthToken < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -85,7 +85,7 @@ module Verizon
       refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
 
       # Create object from extracted values.
-      OauthToken.new(access_token,
+      OAuthToken.new(access_token,
                      token_type,
                      expires_in,
                      scope,