loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['REQUEST_LOG_BODY']
+      log_headers = ENV['REQUEST_LOG_HEADERS']
+      headers_to_include = ENV['REQUEST_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['REQUEST_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['REQUEST_HEADERS_TO_UNMASK']
+      include_query_in_path = ENV['REQUEST_INCLUDE_QUERY_IN_PATH']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        REQUEST_LOG_BODY
+        REQUEST_LOG_HEADERS
+        REQUEST_HEADERS_TO_INCLUDE
+        REQUEST_HEADERS_TO_EXCLUDE
+        REQUEST_HEADERS_TO_UNMASK
+        REQUEST_INCLUDE_QUERY_IN_PATH
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['RESPONSE_LOG_BODY']
+      log_headers = ENV['RESPONSE_LOG_HEADERS']
+      headers_to_include = ENV['RESPONSE_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['RESPONSE_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['RESPONSE_HEADERS_TO_UNMASK']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        RESPONSE_LOG_BODY
+        RESPONSE_LOG_HEADERS
+        RESPONSE_HEADERS_TO_INCLUDE
+        RESPONSE_HEADERS_TO_EXCLUDE
+        RESPONSE_HEADERS_TO_UNMASK
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers ||= self.mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(
+        logger: logger,
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: request_logging_config,
+        response_logging_config: response_logging_config
+      )
+    end
+
+    def self.from_env
+      log_level = ENV['LOG_LEVEL']
+      mask_sensitive_headers = ENV['MASK_SENSITIVE_HEADERS']
+
+      new(
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: RequestLoggingConfiguration.from_env,
+        response_logging_config: ResponseLoggingConfiguration.from_env
+      )
+    end
+
+    def self.any_logging_configured?
+      RequestLoggingConfiguration.any_logging_configured? ||
+        ResponseLoggingConfiguration.any_logging_configured? ||
+        ENV.key?('LOG_LEVEL') ||
+        ENV.key?('MASK_SENSITIVE_HEADERS')
+    end
+  end
+end

data/lib/loyalty_ap_is/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/loyalty_ap_is/models/access_code_response.rb

@@ -0,0 +1,87 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # AccessCodeResponse Model.
+  class AccessCodeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # AccessCode provided by Shell after it redirects the user to the partner's
+    # URL.
+    # @return [String]
+    attr_accessor :access_code
+
+    # Indicates the number of seconds until the accessCode expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_code'] = 'accessCode'
+      @_hash['expires_in'] = 'expiresIn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        access_code
+        expires_in
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_code: SKIP, expires_in: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @access_code = access_code unless access_code == SKIP
+      @expires_in = expires_in unless expires_in == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      access_code = hash.key?('accessCode') ? hash['accessCode'] : SKIP
+      expires_in = hash.key?('expiresIn') ? hash['expiresIn'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccessCodeResponse.new(access_code: access_code,
+                             expires_in: expires_in,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_code: #{@access_code}, expires_in: #{@expires_in},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_code: #{@access_code.inspect}, expires_in: #{@expires_in.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/assign_offer_channel.rb

@@ -0,0 +1,26 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Assign Offer Channel.
+  class AssignOfferChannel
+    ASSIGN_OFFER_CHANNEL = [
+      # TODO: Write general description for PARTNER
+      PARTNER = 'PARTNER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ASSIGN_OFFER_CHANNEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = PARTNER)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/loyalty_ap_is/models/auth_token_request.rb

@@ -0,0 +1,75 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # AuthTokenRequest Model.
+  class AuthTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :digest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['digest'] = 'digest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        digest
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(digest: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @digest = digest unless digest == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      digest = hash.key?('digest') ? hash['digest'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AuthTokenRequest.new(digest: digest,
+                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} digest: #{@digest}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} digest: #{@digest.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/auth_token_response.rb

@@ -0,0 +1,106 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # AuthTokenResponse Model.
+  class AuthTokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your Basic public token which needs to be used in the
+    # auth/ExchangeAccessCode.
+    # @return [String]
+    attr_accessor :token
+
+    # Type of the token.
+    # @return [String]
+    attr_accessor :token_type
+
+    # With value **unlimited** it means this token will never expire
+    # @return [String]
+    attr_accessor :expires_in
+
+    # States the name of the partner to which the digest used belongs
+    # @return [String]
+    attr_accessor :owner
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token'] = 'token'
+      @_hash['token_type'] = 'tokenType'
+      @_hash['expires_in'] = 'expiresIn'
+      @_hash['owner'] = 'owner'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        token
+        token_type
+        expires_in
+        owner
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token: SKIP, token_type: SKIP, expires_in: SKIP, owner: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @token = token unless token == SKIP
+      @token_type = token_type unless token_type == SKIP
+      @expires_in = expires_in unless expires_in == SKIP
+      @owner = owner unless owner == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      token = hash.key?('token') ? hash['token'] : SKIP
+      token_type = hash.key?('tokenType') ? hash['tokenType'] : SKIP
+      expires_in = hash.key?('expiresIn') ? hash['expiresIn'] : SKIP
+      owner = hash.key?('owner') ? hash['owner'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AuthTokenResponse.new(token: token,
+                            token_type: token_type,
+                            expires_in: expires_in,
+                            owner: owner,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token}, token_type: #{@token_type}, expires_in: #{@expires_in},"\
+      " owner: #{@owner}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token.inspect}, token_type: #{@token_type.inspect}, expires_in:"\
+      " #{@expires_in.inspect}, owner: #{@owner.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/bad_request_error.rb

@@ -0,0 +1,63 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Request is missing a parameter so the server cannot proceed with the
+  # request.
+  class BadRequestError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Fault]
+    attr_accessor :fault
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fault'] = 'fault'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fault
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fault: SKIP)
+      @fault = fault unless fault == 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.
+      fault = Fault.from_hash(hash['fault']) if hash['fault']
+
+      # Create object from extracted values.
+      BadRequestError.new(fault: fault)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fault: #{@fault}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fault: #{@fault.inspect}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/balance_amount.rb

@@ -0,0 +1,84 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # List of Balances for the customer
+  class BalanceAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BalanceCurrencyAmount]]
+    attr_accessor :amounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amounts'] = 'amounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amounts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amounts = amounts unless amounts == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      amounts = nil
+      unless hash['amounts'].nil?
+        amounts = []
+        hash['amounts'].each do |structure|
+          amounts << (BalanceCurrencyAmount.from_hash(structure) if structure)
+        end
+      end
+
+      amounts = SKIP unless hash.key?('amounts')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      BalanceAmount.new(amounts: amounts,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amounts: #{@amounts}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amounts: #{@amounts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end