loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/exceptions/json_api_error_exception.rb

@@ -0,0 +1,60 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # JSON API Error class.
+  class JsonApiErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [JsonApiVersion]
+    attr_accessor :jsonapi
+
+    # TODO: Write general description for this method
+    # @return [Array[ErrorItem]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response 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] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @jsonapi = JsonApiVersion.from_hash(hash['jsonapi']) if hash['jsonapi']
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (ErrorItem.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('errors')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} jsonapi: #{@jsonapi}, errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} jsonapi: #{@jsonapi.inspect}, errors: #{@errors.inspect}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/exceptions/oauth_provider_exception.rb

@@ -0,0 +1,64 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # OAuth 2 Authorization endpoint exception.
+  class OauthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OauthProviderError]
+    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] reason The reason for raising an exception.
+    # @param [HttpResponse] response 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] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, error_description: #{@error_description}, error_uri:"\
+      " #{@error_uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, error_description: #{@error_description.inspect},"\
+      " error_uri: #{@error_uri.inspect}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/exceptions/resource_not_found_error_exception.rb

@@ -0,0 +1,57 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Resource Not Found Error class.
+  class ResourceNotFoundErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP error status code
+    # @return [Float]
+    attr_accessor :error_code
+
+    # HTTP error status message
+    # @return [String]
+    attr_accessor :message
+
+    # HTTP error status message
+    # @return [ErrorInfo]
+    attr_accessor :error
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response 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] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
+      @message = hash.key?('message') ? hash['message'] : nil
+      @error = ErrorInfo.from_hash(hash['error']) if hash['error']
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, message: #{@message}, error: #{@error}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, message: #{@message.inspect}, error:"\
+      " #{@error.inspect}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/http/api_response.rb

@@ -0,0 +1,19 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # 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/loyalty_ap_is/http/auth/client_authorization_token.rb

@@ -0,0 +1,148 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Utility class for OAuth 2 authorization and token management.
+  class ClientAuthorizationToken < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ClientAuthorizationToken: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(client_authorization_token_credentials, config)
+      @_oauth_client_id = client_authorization_token_credentials.oauth_client_id unless
+        client_authorization_token_credentials.nil? || client_authorization_token_credentials.oauth_client_id.nil?
+      @_oauth_client_secret = client_authorization_token_credentials.oauth_client_secret unless
+        client_authorization_token_credentials.nil? || client_authorization_token_credentials.oauth_client_secret.nil?
+      @_oauth_token = client_authorization_token_credentials.oauth_token unless
+        client_authorization_token_credentials.nil? || client_authorization_token_credentials.oauth_token.nil?
+      @_oauth_clock_skew = client_authorization_token_credentials.oauth_clock_skew unless
+        client_authorization_token_credentials.nil? || client_authorization_token_credentials.oauth_clock_skew.nil?
+      @_oauth_token_provider = client_authorization_token_credentials.oauth_token_provider unless
+        client_authorization_token_credentials.nil? || client_authorization_token_credentials.oauth_token_provider.nil?
+      @_oauth_on_token_update = client_authorization_token_credentials.oauth_on_token_update unless
+        client_authorization_token_credentials.nil? || client_authorization_token_credentials.oauth_on_token_update.nil?
+      @_o_auth_api = OauthAuthorizationApi.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_client_authorization_token(
+        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, @_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 ClientAuthorizationTokenCredentials.
+  class ClientAuthorizationTokenCredentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_token,
+                :oauth_token_provider, :oauth_on_token_update, :oauth_clock_skew
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_token: nil,
+                   oauth_token_provider: nil, oauth_on_token_update: nil,
+                   oauth_clock_skew: 0)
+      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_token_provider = oauth_token_provider
+      @oauth_on_token_update = oauth_on_token_update
+      @oauth_clock_skew = oauth_clock_skew
+    end
+
+    def self.from_env
+      oauth_client_id = ENV['CLIENT_AUTHORIZATION_TOKEN_OAUTH_CLIENT_ID']
+      oauth_client_secret = ENV['CLIENT_AUTHORIZATION_TOKEN_OAUTH_CLIENT_SECRET']
+      oauth_clock_skew = ENV['CLIENT_AUTHORIZATION_TOKEN_OAUTH_CLOCK_SKEW']
+      all_nil = [
+        oauth_client_id,
+        oauth_client_secret
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(oauth_client_id: oauth_client_id,
+          oauth_client_secret: oauth_client_secret,
+          oauth_clock_skew: oauth_clock_skew)
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_token: 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_token_provider ||= self.oauth_token_provider
+      oauth_on_token_update ||= self.oauth_on_token_update
+      oauth_clock_skew ||= self.oauth_clock_skew
+
+      ClientAuthorizationTokenCredentials.new(
+        oauth_client_id: oauth_client_id,
+        oauth_client_secret: oauth_client_secret, oauth_token: oauth_token,
+        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/loyalty_ap_is/http/auth/customer_header.rb

@@ -0,0 +1,52 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Utility class for custom header authorization.
+  class CustomerHeader < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'CustomerHeader: authorization_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(customer_header_credentials)
+      auth_params = {}
+      auth_params['Authorization-Token'] = customer_header_credentials.authorization_token unless
+        customer_header_credentials.nil? || customer_header_credentials.authorization_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for CustomerHeaderCredentials.
+  # Data class for CustomerHeaderCredentials.
+  class CustomerHeaderCredentials
+    attr_reader :authorization_token
+
+    def initialize(authorization_token:)
+      raise ArgumentError, 'authorization_token cannot be nil' if authorization_token.nil?
+
+      @authorization_token = authorization_token
+    end
+
+    def self.from_env
+      authorization_token = ENV['CUSTOMER_HEADER_AUTHORIZATION_TOKEN']
+      all_nil = [
+        authorization_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(authorization_token: authorization_token)
+    end
+
+    def clone_with(authorization_token: nil)
+      authorization_token ||= self.authorization_token
+
+      CustomerHeaderCredentials.new(authorization_token: authorization_token)
+    end
+  end
+end

data/lib/loyalty_ap_is/http/auth/private_basic_token.rb

@@ -0,0 +1,52 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Utility class for custom header authorization.
+  class PrivateBasicToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PrivateBasicToken: public_basic_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(private_basic_token_credentials)
+      auth_params = {}
+      auth_params['Public Basic Token'] = private_basic_token_credentials.public_basic_token unless
+        private_basic_token_credentials.nil? || private_basic_token_credentials.public_basic_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for PrivateBasicTokenCredentials.
+  # Data class for PrivateBasicTokenCredentials.
+  class PrivateBasicTokenCredentials
+    attr_reader :public_basic_token
+
+    def initialize(public_basic_token:)
+      raise ArgumentError, 'public_basic_token cannot be nil' if public_basic_token.nil?
+
+      @public_basic_token = public_basic_token
+    end
+
+    def self.from_env
+      public_basic_token = ENV['PRIVATE_BASIC_TOKEN_PUBLIC_BASIC_TOKEN']
+      all_nil = [
+        public_basic_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(public_basic_token: public_basic_token)
+    end
+
+    def clone_with(public_basic_token: nil)
+      public_basic_token ||= self.public_basic_token
+
+      PrivateBasicTokenCredentials.new(public_basic_token: public_basic_token)
+    end
+  end
+end

data/lib/loyalty_ap_is/http/auth/public_basic_token.rb

@@ -0,0 +1,52 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Utility class for custom header authorization.
+  class PublicBasicToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PublicBasicToken: public_basic_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(public_basic_token_credentials)
+      auth_params = {}
+      auth_params['Public Basic Token'] = public_basic_token_credentials.public_basic_token unless
+        public_basic_token_credentials.nil? || public_basic_token_credentials.public_basic_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for PublicBasicTokenCredentials.
+  # Data class for PublicBasicTokenCredentials.
+  class PublicBasicTokenCredentials
+    attr_reader :public_basic_token
+
+    def initialize(public_basic_token:)
+      raise ArgumentError, 'public_basic_token cannot be nil' if public_basic_token.nil?
+
+      @public_basic_token = public_basic_token
+    end
+
+    def self.from_env
+      public_basic_token = ENV['PUBLIC_BASIC_TOKEN_PUBLIC_BASIC_TOKEN']
+      all_nil = [
+        public_basic_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(public_basic_token: public_basic_token)
+    end
+
+    def clone_with(public_basic_token: nil)
+      public_basic_token ||= self.public_basic_token
+
+      PublicBasicTokenCredentials.new(public_basic_token: public_basic_token)
+    end
+  end
+end

data/lib/loyalty_ap_is/http/auth/public_bearer_token.rb

@@ -0,0 +1,53 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Utility class for OAuth 2 authorization and token management.
+  class PublicBearerToken < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PublicBearerToken: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(public_bearer_token_credentials)
+      auth_params = {}
+      @_access_token = public_bearer_token_credentials.access_token unless
+        public_bearer_token_credentials.nil? || public_bearer_token_credentials.access_token.nil?
+      auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for PublicBearerTokenCredentials.
+  class PublicBearerTokenCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def self.from_env
+      access_token = ENV['PUBLIC_BEARER_TOKEN_ACCESS_TOKEN']
+      all_nil = [
+        access_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(access_token: access_token)
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      PublicBearerTokenCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/loyalty_ap_is/http/http_call_back.rb

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

data/lib/loyalty_ap_is/http/http_method_enum.rb

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

data/lib/loyalty_ap_is/http/http_request.rb

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

data/lib/loyalty_ap_is/http/http_response.rb

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

data/lib/loyalty_ap_is/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end