loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/configuration.rb

@@ -0,0 +1,238 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      SIT = 'SIT'.freeze,
+      PRODUCTION = 'Production'.freeze,
+      UAT = 'UAT'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = SIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'sit' then SIT
+      when 'production' then PRODUCTION
+      when 'uat' then UAT
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      OAUTH_SERVER = 'OAuth Server'.freeze,
+      SHELL = 'Shell'.freeze,
+      SHELL1 = 'Shell1'.freeze,
+      SHELL2 = 'Shell2'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = OAUTH_SERVER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'oauth_server' then OAUTH_SERVER
+      when 'shell' then SHELL
+      when 'shell1' then SHELL1
+      when 'shell2' then SHELL2
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :public_bearer_token_credentials,
+                :public_basic_token_credentials,
+                :private_basic_token_credentials,
+                :client_authorization_token_credentials,
+                :customer_header_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::SIT,
+      public_bearer_token_credentials: nil, public_basic_token_credentials: nil,
+      private_basic_token_credentials: nil,
+      client_authorization_token_credentials: nil,
+      customer_header_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding OAuth 2 Bearer token credentials
+      @public_bearer_token_credentials = public_bearer_token_credentials
+
+      # The object holding Custom Header Signature credentials
+      @public_basic_token_credentials = public_basic_token_credentials
+
+      # The object holding Custom Header Signature credentials
+      @private_basic_token_credentials = private_basic_token_credentials
+
+      # The object holding OAuth 2 Client Credentials Grant credentials
+      @client_authorization_token_credentials = client_authorization_token_credentials
+
+      # The object holding Custom Header Signature credentials
+      @customer_header_credentials = customer_header_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, public_bearer_token_credentials: nil,
+                   public_basic_token_credentials: nil,
+                   private_basic_token_credentials: nil,
+                   client_authorization_token_credentials: nil,
+                   customer_header_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      public_bearer_token_credentials ||= self.public_bearer_token_credentials
+      public_basic_token_credentials ||= self.public_basic_token_credentials
+      private_basic_token_credentials ||= self.private_basic_token_credentials
+      client_authorization_token_credentials ||= self.client_authorization_token_credentials
+      customer_header_credentials ||= self.customer_header_credentials
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration, environment: environment,
+        public_bearer_token_credentials: public_bearer_token_credentials,
+        public_basic_token_credentials: public_basic_token_credentials,
+        private_basic_token_credentials: private_basic_token_credentials,
+        client_authorization_token_credentials: client_authorization_token_credentials,
+        customer_header_credentials: customer_header_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::SIT => {
+        Server::OAUTH_SERVER => 'https://api-test.shell.com',
+        Server::SHELL => 'https://api-test.shell.com',
+        Server::SHELL1 => 'https://api-test.shell.com/loyalty/v1',
+        Server::SHELL2 => 'https://api-test.shell.com/loyalty'
+      },
+      Environment::PRODUCTION => {
+        Server::OAUTH_SERVER => 'https://api.shell.com',
+        Server::SHELL => 'https://id.consumer.shell.com',
+        Server::SHELL1 => 'https://api.shell.com/loyalty/v1',
+        Server::SHELL2 => 'https://api.shell.com/loyalty'
+      },
+      Environment::UAT => {
+        Server::OAUTH_SERVER => 'https://api.shell.com',
+        Server::SHELL => 'https://test.id.consumer.shell.com',
+        Server::SHELL1 => 'https://api-uat.shell.com/loyalty/v1',
+        Server::SHELL2 => 'https://api-uat.shell.com/loyalty'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::SHELL)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'sit'))
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      public_bearer_token_credentials = PublicBearerTokenCredentials.from_env
+      public_basic_token_credentials = PublicBasicTokenCredentials.from_env
+      private_basic_token_credentials = PrivateBasicTokenCredentials.from_env
+      client_authorization_token_credentials = ClientAuthorizationTokenCredentials.from_env
+      customer_header_credentials = CustomerHeaderCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        public_bearer_token_credentials: public_bearer_token_credentials,
+        public_basic_token_credentials: public_basic_token_credentials,
+        private_basic_token_credentials: private_basic_token_credentials,
+        client_authorization_token_credentials: client_authorization_token_credentials,
+        customer_header_credentials: customer_header_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/loyalty_ap_is/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/exceptions/common_error_exception.rb

@@ -0,0 +1,98 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Common Error class.
+  class CommonErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # custom error code for developer or user
+    # Note: One of the following values will be returned:
+    # 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1009, 1010, 1011, 1012,
+    # 1014, 1015, 1016
+    # @return [Float]
+    attr_accessor :error_code
+
+    # Custom error message <br>
+    # Note: One of the following values will be returned:
+    #   - Offer does not exist
+    #   - Customer does not exist
+    #   - Valid from date is invalid
+    #   - ValidityPeriod is invalid
+    #   - Offer is by default assigned to all customers, which cannot be
+    # changed.
+    #   - Assignment is not allowed
+    #   - Customer assign should have validity dates.
+    #   - Customer assign validity start date should be before the validity end
+    # date.
+    #   - Customer assign validity dates must be between the offer assignable
+    # dates.
+    #   - Offer validity start date should not be in the past.
+    #   - Customer already assigned to this offer.
+    #   - Offer module is disabled
+    #   - Partner code is not valid for this offer
+    #   - Reference ID already used
+    #   - Partner assignment already ended for this customer
+    # @return [String]
+    attr_accessor :message
+
+    # Custom error message <br>
+    # Note: One of the following values will be returned:
+    #   - Offer does not exist
+    #   - Customer does not exist
+    #   - Valid from date is invalid
+    #   - ValidityPeriod is invalid
+    #   - Offer is by default assigned to all customers, which cannot be
+    # changed.
+    #   - Assignment is not allowed
+    #   - Customer assign should have validity dates.
+    #   - Customer assign validity start date should be before the validity end
+    # date.
+    #   - Customer assign validity dates must be between the offer assignable
+    # dates.
+    #   - Offer validity start date should not be in the past.
+    #   - Customer already assigned to this offer.
+    #   - Offer module is disabled
+    #   - Partner code is not valid for this offer
+    #   - Reference ID already used
+    #   - Partner assignment already ended for this customer
+    # @return [ErrorBaseContainer]
+    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 = ErrorBaseContainer.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/exceptions/consumers_balances400_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
+  # Consumers Balances 400 Error class.
+  class ConsumersBalances400ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    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 = hash.key?('error') ? hash['error'] : nil
+    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/exceptions/consumers_balances401_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
+  # Consumers Balances 401 Error class.
+  class ConsumersBalances401ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    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 = hash.key?('error') ? hash['error'] : nil
+    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/exceptions/consumers_balances404_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
+  # Consumers Balances 404 Error class.
+  class ConsumersBalances404ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    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 = hash.key?('error') ? hash['error'] : nil
+    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/exceptions/consumers_balances422_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
+  # Consumers Balances 422 Error class.
+  class ConsumersBalances422ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    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 = hash.key?('error') ? hash['error'] : nil
+    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/exceptions/error_response_exception.rb

@@ -0,0 +1,57 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Error Response class.
+  class ErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP error 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