loyalty-sdk 0.0.1

data/lib/loyalty_ap_is/models/site_data.rb

@@ -0,0 +1,121 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # SiteData Model.
+  class SiteData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Two character ISO 3166-1 alpha-2 country code
+    # @return [String]
+    attr_accessor :country_code
+
+    # Unique Id of the site
+    # @return [String]
+    attr_accessor :site_id
+
+    # Name of the site
+    # @return [String]
+    attr_accessor :name
+
+    # Postcode of the site
+    # @return [String]
+    attr_accessor :postcode
+
+    # City of the site
+    # @return [String]
+    attr_accessor :city
+
+    # Address of the site
+    # @return [String]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_code'] = 'countryCode'
+      @_hash['site_id'] = 'siteId'
+      @_hash['name'] = 'name'
+      @_hash['postcode'] = 'postcode'
+      @_hash['city'] = 'city'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        postcode
+        city
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code:, site_id:, name:, postcode: SKIP, city: SKIP,
+                   address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @country_code = country_code
+      @site_id = site_id
+      @name = name
+      @postcode = postcode unless postcode == SKIP
+      @city = city unless city == SKIP
+      @address = address unless address == 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.
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : nil
+      site_id = hash.key?('siteId') ? hash['siteId'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      postcode = hash.key?('postcode') ? hash['postcode'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      address = hash.key?('address') ? hash['address'] : 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.
+      SiteData.new(country_code: country_code,
+                   site_id: site_id,
+                   name: name,
+                   postcode: postcode,
+                   city: city,
+                   address: address,
+                   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} country_code: #{@country_code}, site_id: #{@site_id}, name: #{@name},"\
+      " postcode: #{@postcode}, city: #{@city}, address: #{@address}, 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} country_code: #{@country_code.inspect}, site_id: #{@site_id.inspect}, name:"\
+      " #{@name.inspect}, postcode: #{@postcode.inspect}, city: #{@city.inspect}, address:"\
+      " #{@address.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/transaction.rb

@@ -0,0 +1,351 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module LoyaltyApIs
+  # Transaction Model.
+  class Transaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction date as Unix epoch (UTC), as requested by MobGen.
+    # @return [Integer]
+    attr_accessor :transaction_date_time
+
+    # Transaction date in JSON recommended format: “yyyy-MM-ddTHH:mm:ssZ”
+    # @return [DateTime]
+    attr_accessor :transaction_date_time_stamp
+
+    # Transaction date in JSON recommended format: “yyyy-MM-ddTHH:mm:ssZ”
+    # @return [SiteData]
+    attr_accessor :site_data
+
+    # Transaction date in JSON recommended format: “yyyy-MM-ddTHH:mm:ssZ”
+    # @return [LoyaltyCardInfo]
+    attr_accessor :loyalty
+
+    # Unique Id of the transaction row.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Unique code identifying the partner
+    # @return [String]
+    attr_accessor :partner_code
+
+    # Name of the partner
+    # @return [String]
+    attr_accessor :partner_name
+
+    # Name of the partner
+    # @return [String]
+    attr_accessor :partner_logo
+
+    # Reference ID for each transaction. It is unique for each partner and
+    # transaction.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # Total amount of the transaction.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Total discount amount of the transaction.
+    # @return [Float]
+    attr_accessor :total_discount_amount
+
+    # totalAmount - totalDiscountedFullAmount
+    # @return [Float]
+    attr_accessor :total_discounted_full_amount
+
+    # Total amount of VAT
+    # @return [Float]
+    attr_accessor :total_vat_amount
+
+    # Total amount of VAT
+    # @return [Array[TransactionBalance]]
+    attr_accessor :balances
+
+    # Currency using ISO4217 alpha-3 currency code
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Currency using ISO4217 alpha-3 currency code
+    # @return [Array[SaleItem]]
+    attr_accessor :sale_items
+
+    # Currency using ISO4217 alpha-3 currency code
+    # @return [Array[RedeemedItem]]
+    attr_accessor :redeemed_items
+
+    # Currency using ISO4217 alpha-3 currency code
+    # @return [Array[TransactionVoucher]]
+    attr_accessor :transaction_vouchers
+
+    # Unique number of transaction's receipt
+    # @return [String]
+    attr_accessor :receipt_number
+
+    # Unique number of transaction's receipt
+    # @return [PointsToCash]
+    attr_accessor :points_to_cash
+
+    # Partner identifier
+    # @return [Integer]
+    attr_accessor :company_id
+
+    # Describes whether the transaction is partner redemption.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_partner_redemption
+
+    # currencyData is only filled, where there is possible non-same currency
+    # cross-border transaction
+    # @return [CurrencyData]
+    attr_accessor :currency_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_date_time'] = 'transactionDateTime'
+      @_hash['transaction_date_time_stamp'] = 'transactionDateTimeStamp'
+      @_hash['site_data'] = 'siteData'
+      @_hash['loyalty'] = 'loyalty'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['partner_code'] = 'partnerCode'
+      @_hash['partner_name'] = 'partnerName'
+      @_hash['partner_logo'] = 'partnerLogo'
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['total_amount'] = 'totalAmount'
+      @_hash['total_discount_amount'] = 'totalDiscountAmount'
+      @_hash['total_discounted_full_amount'] = 'totalDiscountedFullAmount'
+      @_hash['total_vat_amount'] = 'totalVatAmount'
+      @_hash['balances'] = 'balances'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['sale_items'] = 'saleItems'
+      @_hash['redeemed_items'] = 'redeemedItems'
+      @_hash['transaction_vouchers'] = 'transactionVouchers'
+      @_hash['receipt_number'] = 'receiptNumber'
+      @_hash['points_to_cash'] = 'pointsToCash'
+      @_hash['company_id'] = 'companyId'
+      @_hash['is_partner_redemption'] = 'isPartnerRedemption'
+      @_hash['currency_data'] = 'currencyData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_date_time_stamp
+        transaction_id
+        partner_code
+        partner_name
+        partner_logo
+        reference_id
+        total_vat_amount
+        balances
+        currency_code
+        receipt_number
+        points_to_cash
+        company_id
+        is_partner_redemption
+        currency_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_date_time:, site_data:, loyalty:, total_amount:,
+                   total_discount_amount:, total_discounted_full_amount:,
+                   sale_items:, redeemed_items:, transaction_vouchers:,
+                   transaction_date_time_stamp: SKIP, transaction_id: SKIP,
+                   partner_code: SKIP, partner_name: SKIP, partner_logo: SKIP,
+                   reference_id: SKIP, total_vat_amount: SKIP, balances: SKIP,
+                   currency_code: SKIP, receipt_number: SKIP,
+                   points_to_cash: SKIP, company_id: SKIP,
+                   is_partner_redemption: SKIP, currency_data: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_date_time = transaction_date_time
+      unless transaction_date_time_stamp == SKIP
+        @transaction_date_time_stamp =
+          transaction_date_time_stamp
+      end
+      @site_data = site_data
+      @loyalty = loyalty
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @partner_code = partner_code unless partner_code == SKIP
+      @partner_name = partner_name unless partner_name == SKIP
+      @partner_logo = partner_logo unless partner_logo == SKIP
+      @reference_id = reference_id unless reference_id == SKIP
+      @total_amount = total_amount
+      @total_discount_amount = total_discount_amount
+      @total_discounted_full_amount = total_discounted_full_amount
+      @total_vat_amount = total_vat_amount unless total_vat_amount == SKIP
+      @balances = balances unless balances == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @sale_items = sale_items
+      @redeemed_items = redeemed_items
+      @transaction_vouchers = transaction_vouchers
+      @receipt_number = receipt_number unless receipt_number == SKIP
+      @points_to_cash = points_to_cash unless points_to_cash == SKIP
+      @company_id = company_id unless company_id == SKIP
+      @is_partner_redemption = is_partner_redemption unless is_partner_redemption == SKIP
+      @currency_data = currency_data unless currency_data == 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.
+      transaction_date_time =
+        hash.key?('transactionDateTime') ? hash['transactionDateTime'] : nil
+      site_data = SiteData.from_hash(hash['siteData']) if hash['siteData']
+      loyalty = LoyaltyCardInfo.from_hash(hash['loyalty']) if hash['loyalty']
+      total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : nil
+      total_discount_amount =
+        hash.key?('totalDiscountAmount') ? hash['totalDiscountAmount'] : nil
+      total_discounted_full_amount =
+        hash.key?('totalDiscountedFullAmount') ? hash['totalDiscountedFullAmount'] : nil
+      # Parameter is an array, so we need to iterate through it
+      sale_items = nil
+      unless hash['saleItems'].nil?
+        sale_items = []
+        hash['saleItems'].each do |structure|
+          sale_items << (SaleItem.from_hash(structure) if structure)
+        end
+      end
+
+      sale_items = nil unless hash.key?('saleItems')
+      # Parameter is an array, so we need to iterate through it
+      redeemed_items = nil
+      unless hash['redeemedItems'].nil?
+        redeemed_items = []
+        hash['redeemedItems'].each do |structure|
+          redeemed_items << (RedeemedItem.from_hash(structure) if structure)
+        end
+      end
+
+      redeemed_items = nil unless hash.key?('redeemedItems')
+      # Parameter is an array, so we need to iterate through it
+      transaction_vouchers = nil
+      unless hash['transactionVouchers'].nil?
+        transaction_vouchers = []
+        hash['transactionVouchers'].each do |structure|
+          transaction_vouchers << (TransactionVoucher.from_hash(structure) if structure)
+        end
+      end
+
+      transaction_vouchers = nil unless hash.key?('transactionVouchers')
+      transaction_date_time_stamp = if hash.key?('transactionDateTimeStamp')
+                                      (DateTimeHelper.from_rfc3339(hash['transactionDateTimeStamp']) if hash['transactionDateTimeStamp'])
+                                    else
+                                      SKIP
+                                    end
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      partner_code = hash.key?('partnerCode') ? hash['partnerCode'] : SKIP
+      partner_name = hash.key?('partnerName') ? hash['partnerName'] : SKIP
+      partner_logo = hash.key?('partnerLogo') ? hash['partnerLogo'] : SKIP
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : SKIP
+      total_vat_amount =
+        hash.key?('totalVatAmount') ? hash['totalVatAmount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      balances = nil
+      unless hash['balances'].nil?
+        balances = []
+        hash['balances'].each do |structure|
+          balances << (TransactionBalance.from_hash(structure) if structure)
+        end
+      end
+
+      balances = SKIP unless hash.key?('balances')
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      receipt_number = hash.key?('receiptNumber') ? hash['receiptNumber'] : SKIP
+      points_to_cash = PointsToCash.from_hash(hash['pointsToCash']) if hash['pointsToCash']
+      company_id = hash.key?('companyId') ? hash['companyId'] : SKIP
+      is_partner_redemption =
+        hash.key?('isPartnerRedemption') ? hash['isPartnerRedemption'] : SKIP
+      currency_data = CurrencyData.from_hash(hash['currencyData']) if hash['currencyData']
+
+      # 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.
+      Transaction.new(transaction_date_time: transaction_date_time,
+                      site_data: site_data,
+                      loyalty: loyalty,
+                      total_amount: total_amount,
+                      total_discount_amount: total_discount_amount,
+                      total_discounted_full_amount: total_discounted_full_amount,
+                      sale_items: sale_items,
+                      redeemed_items: redeemed_items,
+                      transaction_vouchers: transaction_vouchers,
+                      transaction_date_time_stamp: transaction_date_time_stamp,
+                      transaction_id: transaction_id,
+                      partner_code: partner_code,
+                      partner_name: partner_name,
+                      partner_logo: partner_logo,
+                      reference_id: reference_id,
+                      total_vat_amount: total_vat_amount,
+                      balances: balances,
+                      currency_code: currency_code,
+                      receipt_number: receipt_number,
+                      points_to_cash: points_to_cash,
+                      company_id: company_id,
+                      is_partner_redemption: is_partner_redemption,
+                      currency_data: currency_data,
+                      additional_properties: additional_properties)
+    end
+
+    def to_custom_transaction_date_time_stamp
+      DateTimeHelper.to_rfc3339(transaction_date_time_stamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_date_time: #{@transaction_date_time},"\
+      " transaction_date_time_stamp: #{@transaction_date_time_stamp}, site_data: #{@site_data},"\
+      " loyalty: #{@loyalty}, transaction_id: #{@transaction_id}, partner_code: #{@partner_code},"\
+      " partner_name: #{@partner_name}, partner_logo: #{@partner_logo}, reference_id:"\
+      " #{@reference_id}, total_amount: #{@total_amount}, total_discount_amount:"\
+      " #{@total_discount_amount}, total_discounted_full_amount: #{@total_discounted_full_amount},"\
+      " total_vat_amount: #{@total_vat_amount}, balances: #{@balances}, currency_code:"\
+      " #{@currency_code}, sale_items: #{@sale_items}, redeemed_items: #{@redeemed_items},"\
+      " transaction_vouchers: #{@transaction_vouchers}, receipt_number: #{@receipt_number},"\
+      " points_to_cash: #{@points_to_cash}, company_id: #{@company_id}, is_partner_redemption:"\
+      " #{@is_partner_redemption}, currency_data: #{@currency_data}, 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} transaction_date_time: #{@transaction_date_time.inspect},"\
+      " transaction_date_time_stamp: #{@transaction_date_time_stamp.inspect}, site_data:"\
+      " #{@site_data.inspect}, loyalty: #{@loyalty.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}, partner_code: #{@partner_code.inspect}, partner_name:"\
+      " #{@partner_name.inspect}, partner_logo: #{@partner_logo.inspect}, reference_id:"\
+      " #{@reference_id.inspect}, total_amount: #{@total_amount.inspect}, total_discount_amount:"\
+      " #{@total_discount_amount.inspect}, total_discounted_full_amount:"\
+      " #{@total_discounted_full_amount.inspect}, total_vat_amount: #{@total_vat_amount.inspect},"\
+      " balances: #{@balances.inspect}, currency_code: #{@currency_code.inspect}, sale_items:"\
+      " #{@sale_items.inspect}, redeemed_items: #{@redeemed_items.inspect}, transaction_vouchers:"\
+      " #{@transaction_vouchers.inspect}, receipt_number: #{@receipt_number.inspect},"\
+      " points_to_cash: #{@points_to_cash.inspect}, company_id: #{@company_id.inspect},"\
+      " is_partner_redemption: #{@is_partner_redemption.inspect}, currency_data:"\
+      " #{@currency_data.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/loyalty_ap_is/models/transaction_balance.rb

@@ -0,0 +1,91 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # TransactionBalance Model.
+  class TransactionBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of balance
+    # @return [TransactionCurrencyType]
+    attr_accessor :currency_type
+
+    # Type of balance
+    # @return [Array[TransactionBalanceAmount]]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency_type:, amounts:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency_type = currency_type
+      @amounts = amounts
+      @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 << (TransactionBalanceAmount.from_hash(structure) if structure)
+        end
+      end
+
+      amounts = nil 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.
+      TransactionBalance.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/transaction_balance_amount.rb

@@ -0,0 +1,82 @@
+# loyalty_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module LoyaltyApIs
+  # TransactionBalanceAmount Model.
+  class TransactionBalanceAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Current value of specified balance
+    # @return [Float]
+    attr_accessor :amount
+
+    # State of the amount
+    # @return [TransactionBalanceState]
+    attr_accessor :state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['state'] = 'state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, state:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @state = state
+      @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
+
+      # 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.
+      TransactionBalanceAmount.new(amount: amount,
+                                   state: state,
+                                   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} amount: #{@amount}, state: #{@state}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end