loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/models/balance_amount_detail.rb

@@ -0,0 +1,141 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module LoyaltyApIs
+  # BalanceAmountDetail Model.
+  class BalanceAmountDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Current value of specified balance.
+    # @return [Float]
+    attr_accessor :amount
+
+    # State of the points balance amount.
+    # @return [BalanceState]
+    attr_accessor :state
+
+    # Expiration Date in JSON recommended format: “yyyy-MM-ddTHH:mm:ssZ”
+    # Nullable.
+    # @return [DateTime]
+    attr_accessor :date_time
+
+    # Date as Unix epoch (UTC).
+    # @return [Integer]
+    attr_accessor :date_timestamp
+
+    # Point to cash exchange amnount.
+    # @return [Float]
+    attr_accessor :cash_amount
+
+    # Period of expiration, minimum value is 1. Seralized only when it’s not
+    # null.
+    # @return [Integer]
+    attr_accessor :period
+
+    # The list of numbers describes an index of boost’s position in qualifying
+    # visit, Seralized only when it’s not null and not empty.
+    # @return [Array[Integer]]
+    attr_accessor :position
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['state'] = 'state'
+      @_hash['date_time'] = 'dateTime'
+      @_hash['date_timestamp'] = 'dateTimestamp'
+      @_hash['cash_amount'] = 'cashAmount'
+      @_hash['period'] = 'period'
+      @_hash['position'] = 'position'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cash_amount
+        period
+        position
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, state:, date_time:, date_timestamp:,
+                   cash_amount: SKIP, period: SKIP, position: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @state = state
+      @date_time = date_time
+      @date_timestamp = date_timestamp
+      @cash_amount = cash_amount unless cash_amount == SKIP
+      @period = period unless period == SKIP
+      @position = position unless position == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      state = hash.key?('state') ? hash['state'] : nil
+      date_time = if hash.key?('dateTime')
+                    (DateTimeHelper.from_rfc3339(hash['dateTime']) if hash['dateTime'])
+                  end
+      date_timestamp = hash.key?('dateTimestamp') ? hash['dateTimestamp'] : nil
+      cash_amount = hash.key?('cashAmount') ? hash['cashAmount'] : SKIP
+      period = hash.key?('period') ? hash['period'] : SKIP
+      position = hash.key?('position') ? hash['position'] : 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.
+      BalanceAmountDetail.new(amount: amount,
+                              state: state,
+                              date_time: date_time,
+                              date_timestamp: date_timestamp,
+                              cash_amount: cash_amount,
+                              period: period,
+                              position: position,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_date_time
+      DateTimeHelper.to_rfc3339(date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, state: #{@state}, date_time: #{@date_time},"\
+      " date_timestamp: #{@date_timestamp}, cash_amount: #{@cash_amount}, period: #{@period},"\
+      " position: #{@position}, 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} amount: #{@amount.inspect}, state: #{@state.inspect}, date_time:"\
+      " #{@date_time.inspect}, date_timestamp: #{@date_timestamp.inspect}, cash_amount:"\
+      " #{@cash_amount.inspect}, period: #{@period.inspect}, position: #{@position.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/balance_currency_amount.rb

@@ -0,0 +1,93 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # BalanceCurrencyAmount Model.
+  class BalanceCurrencyAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [BalanceCurrencyType]
+    attr_accessor :currency_type
+
+    # TODO: Write general description for this method
+    # @return [Array[BalanceAmountDetail]]
+    attr_accessor :amounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_type'] = 'currencyType'
+      @_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(currency_type:, amounts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency_type = currency_type
+      @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.
+      currency_type = hash.key?('currencyType') ? hash['currencyType'] : nil
+      # Parameter is an array, so we need to iterate through it
+      amounts = nil
+      unless hash['amounts'].nil?
+        amounts = []
+        hash['amounts'].each do |structure|
+          amounts << (BalanceAmountDetail.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.
+      BalanceCurrencyAmount.new(currency_type: currency_type,
+                                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} currency_type: #{@currency_type}, 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} currency_type: #{@currency_type.inspect}, amounts: #{@amounts.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/balance_currency_type.rb

@@ -0,0 +1,60 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Balance Currency Type.
+  class BalanceCurrencyType
+    BALANCE_CURRENCY_TYPE = [
+      # TODO: Write general description for QV
+      QV = 'QV'.freeze,
+
+      # TODO: Write general description for POINT
+      POINT = 'POINT'.freeze,
+
+      # TODO: Write general description for STAMP
+      STAMP = 'STAMP'.freeze,
+
+      # TODO: Write general description for AIRMILES
+      AIRMILES = 'AIRMILES'.freeze,
+
+      # TODO: Write general description for MILES
+      MILES = 'MILES'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for STAMP_COUNTER
+      STAMP_COUNTER = 'STAMP_COUNTER'.freeze,
+
+      # TODO: Write general description for NBS
+      NBS = 'NBS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BALANCE_CURRENCY_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = QV)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'qv' then QV
+      when 'point' then POINT
+      when 'stamp' then STAMP
+      when 'airmiles' then AIRMILES
+      when 'miles' then MILES
+      when 'cash' then CASH
+      when 'stamp_counter' then STAMP_COUNTER
+      when 'nbs' then NBS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/loyalty_ap_is/models/balance_state.rb

@@ -0,0 +1,72 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # State of the points balance amount.
+  class BalanceState
+    BALANCE_STATE = [
+      # TODO: Write general description for AVAILABLE
+      AVAILABLE = 'AVAILABLE'.freeze,
+
+      # TODO: Write general description for EXPIRING
+      EXPIRING = 'EXPIRING'.freeze,
+
+      # TODO: Write general description for RESERVED
+      RESERVED = 'RESERVED'.freeze,
+
+      # TODO: Write general description for TARGET
+      TARGET = 'TARGET'.freeze,
+
+      # TODO: Write general description for BOOST
+      BOOST = 'BOOST'.freeze,
+
+      # TODO: Write general description for CHANGE
+      CHANGE = 'CHANGE'.freeze,
+
+      # TODO: Write general description for TOTAL_SPENT
+      TOTAL_SPENT = 'TOTAL_SPENT'.freeze,
+
+      # TODO: Write general description for EARNED
+      EARNED = 'EARNED'.freeze,
+
+      # TODO: Write general description for REDEEMED
+      REDEEMED = 'REDEEMED'.freeze,
+
+      # TODO: Write general description for TOTAL
+      TOTAL = 'TOTAL'.freeze,
+
+      # TODO: Write general description for LAST
+      LAST = 'LAST'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BALANCE_STATE.include?(value)
+    end
+
+    def self.from_value(value, default_value = AVAILABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'available' then AVAILABLE
+      when 'expiring' then EXPIRING
+      when 'reserved' then RESERVED
+      when 'target' then TARGET
+      when 'boost' then BOOST
+      when 'change' then CHANGE
+      when 'total_spent' then TOTAL_SPENT
+      when 'earned' then EARNED
+      when 'redeemed' then REDEEMED
+      when 'total' then TOTAL
+      when 'last' then LAST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/loyalty_ap_is/models/base_model.rb

@@ -0,0 +1,110 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/loyalty_ap_is/models/client_auth_token_request.rb

@@ -0,0 +1,78 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # ClientAuthTokenRequest Model.
+  class ClientAuthTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Client ID provided by Shell
+    # @return [String]
+    attr_accessor :client_id
+
+    # Client Secret provided by Shell
+    # @return [String]
+    attr_accessor :client_secret
+
+    # Grant type value for access
+    # @return [String]
+    attr_accessor :grant_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash['grant_type'] = 'grant_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id:, client_secret:, grant_type:)
+      @client_id = client_id
+      @client_secret = client_secret
+      @grant_type = grant_type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      client_id = hash.key?('client_id') ? hash['client_id'] : nil
+      client_secret = hash.key?('client_secret') ? hash['client_secret'] : nil
+      grant_type = hash.key?('grant_type') ? hash['grant_type'] : nil
+
+      # Create object from extracted values.
+      ClientAuthTokenRequest.new(client_id: client_id,
+                                 client_secret: client_secret,
+                                 grant_type: grant_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id}, client_secret: #{@client_secret}, grant_type:"\
+      " #{@grant_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id.inspect}, client_secret: #{@client_secret.inspect},"\
+      " grant_type: #{@grant_type.inspect}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/currency_data.rb

@@ -0,0 +1,101 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # currencyData is only filled, where there is possible non-same currency
+  # cross-border transaction
+  class CurrencyData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Currency code
+    # @return [String]
+    attr_accessor :code
+
+    # Currency symbol
+    # @return [String]
+    attr_accessor :symbol
+
+    # Currency format (is the symbol after the value)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_suffix
+
+    # Currency format (is there a space between the symbol and the value)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_space
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['symbol'] = 'symbol'
+      @_hash['is_suffix'] = 'isSuffix'
+      @_hash['has_space'] = 'hasSpace'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code:, symbol:, is_suffix:, has_space:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code
+      @symbol = symbol
+      @is_suffix = is_suffix
+      @has_space = has_space
+      @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.
+      code = hash.key?('code') ? hash['code'] : nil
+      symbol = hash.key?('symbol') ? hash['symbol'] : nil
+      is_suffix = hash.key?('isSuffix') ? hash['isSuffix'] : nil
+      has_space = hash.key?('hasSpace') ? hash['hasSpace'] : nil
+
+      # 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.
+      CurrencyData.new(code: code,
+                       symbol: symbol,
+                       is_suffix: is_suffix,
+                       has_space: has_space,
+                       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} code: #{@code}, symbol: #{@symbol}, is_suffix: #{@is_suffix}, has_space:"\
+      " #{@has_space}, 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} code: #{@code.inspect}, symbol: #{@symbol.inspect}, is_suffix:"\
+      " #{@is_suffix.inspect}, has_space: #{@has_space.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end