fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/reward_program_entity.rb

@@ -0,0 +1,136 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Reward program detail
+  class RewardProgramEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long term persistent identity of the reward program
+    # @return [String]
+    attr_accessor :reward_program_id
+
+    # Name of reward program
+    # @return [String]
+    attr_accessor :program_name
+
+    # URL of reward program
+    # @return [String]
+    attr_accessor :program_url
+
+    # Array of reward memberships
+    # @return [Array[RewardProgramMembershipEntity]]
+    attr_accessor :memberships
+
+    # Array of FI-specific attributes
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reward_program_id'] = 'rewardProgramId'
+      @_hash['program_name'] = 'programName'
+      @_hash['program_url'] = 'programUrl'
+      @_hash['memberships'] = 'memberships'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reward_program_id
+        program_name
+        program_url
+        memberships
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reward_program_id: SKIP, program_name: SKIP,
+                   program_url: SKIP, memberships: SKIP, fi_attributes: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reward_program_id = reward_program_id unless reward_program_id == SKIP
+      @program_name = program_name unless program_name == SKIP
+      @program_url = program_url unless program_url == SKIP
+      @memberships = memberships unless memberships == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == 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.
+      reward_program_id =
+        hash.key?('rewardProgramId') ? hash['rewardProgramId'] : SKIP
+      program_name = hash.key?('programName') ? hash['programName'] : SKIP
+      program_url = hash.key?('programUrl') ? hash['programUrl'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      memberships = nil
+      unless hash['memberships'].nil?
+        memberships = []
+        hash['memberships'].each do |structure|
+          memberships << (RewardProgramMembershipEntity.from_hash(structure) if structure)
+        end
+      end
+
+      memberships = SKIP unless hash.key?('memberships')
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # 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.
+      RewardProgramEntity.new(reward_program_id: reward_program_id,
+                              program_name: program_name,
+                              program_url: program_url,
+                              memberships: memberships,
+                              fi_attributes: fi_attributes,
+                              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} reward_program_id: #{@reward_program_id}, program_name: #{@program_name},"\
+      " program_url: #{@program_url}, memberships: #{@memberships}, fi_attributes:"\
+      " #{@fi_attributes}, 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} reward_program_id: #{@reward_program_id.inspect}, program_name:"\
+      " #{@program_name.inspect}, program_url: #{@program_url.inspect}, memberships:"\
+      " #{@memberships.inspect}, fi_attributes: #{@fi_attributes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/reward_program_membership_entity.rb

@@ -0,0 +1,147 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Details of a single membership in a reward programs
+  class RewardProgramMembershipEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # accountIds associated to the reward program
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # Long-term persistent identity of the associated Customer
+    # @return [String]
+    attr_accessor :customer_id
+
+    # Long term persistent identity of the program member
+    # @return [String]
+    attr_accessor :member_id
+
+    # Reward program membership number
+    # @return [String]
+    attr_accessor :member_number
+
+    # If the reward program is tiered, member's current tier
+    # @return [String]
+    attr_accessor :member_tier
+
+    # BUSINESS or CONSUMER membership
+    # @return [BusinessOrConsumerType1]
+    attr_accessor :business_or_consumer
+
+    # Array of balances
+    # @return [Array[RewardBalanceEntity]]
+    attr_accessor :balances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_ids'] = 'accountIds'
+      @_hash['customer_id'] = 'customerId'
+      @_hash['member_id'] = 'memberId'
+      @_hash['member_number'] = 'memberNumber'
+      @_hash['member_tier'] = 'memberTier'
+      @_hash['business_or_consumer'] = 'businessOrConsumer'
+      @_hash['balances'] = 'balances'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_ids
+        customer_id
+        member_id
+        member_number
+        member_tier
+        business_or_consumer
+        balances
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_ids: SKIP, customer_id: SKIP, member_id: SKIP,
+                   member_number: SKIP, member_tier: SKIP,
+                   business_or_consumer: SKIP, balances: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_ids = account_ids unless account_ids == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @member_id = member_id unless member_id == SKIP
+      @member_number = member_number unless member_number == SKIP
+      @member_tier = member_tier unless member_tier == SKIP
+      @business_or_consumer = business_or_consumer unless business_or_consumer == SKIP
+      @balances = balances unless balances == 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.
+      account_ids = hash.key?('accountIds') ? hash['accountIds'] : SKIP
+      customer_id = hash.key?('customerId') ? hash['customerId'] : SKIP
+      member_id = hash.key?('memberId') ? hash['memberId'] : SKIP
+      member_number = hash.key?('memberNumber') ? hash['memberNumber'] : SKIP
+      member_tier = hash.key?('memberTier') ? hash['memberTier'] : SKIP
+      business_or_consumer =
+        hash.key?('businessOrConsumer') ? hash['businessOrConsumer'] : 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 << (RewardBalanceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      balances = SKIP unless hash.key?('balances')
+
+      # 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.
+      RewardProgramMembershipEntity.new(account_ids: account_ids,
+                                        customer_id: customer_id,
+                                        member_id: member_id,
+                                        member_number: member_number,
+                                        member_tier: member_tier,
+                                        business_or_consumer: business_or_consumer,
+                                        balances: balances,
+                                        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} account_ids: #{@account_ids}, customer_id: #{@customer_id}, member_id:"\
+      " #{@member_id}, member_number: #{@member_number}, member_tier: #{@member_tier},"\
+      " business_or_consumer: #{@business_or_consumer}, balances: #{@balances},"\
+      " 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} account_ids: #{@account_ids.inspect}, customer_id: #{@customer_id.inspect},"\
+      " member_id: #{@member_id.inspect}, member_number: #{@member_number.inspect}, member_tier:"\
+      " #{@member_tier.inspect}, business_or_consumer: #{@business_or_consumer.inspect}, balances:"\
+      " #{@balances.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/reward_programs_entity.rb

@@ -0,0 +1,104 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An optionally paginated array of reward programs
+  class RewardProgramsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks]
+    attr_accessor :links
+
+    # Array of reward programs
+    # @return [Array[RewardProgramEntity]]
+    attr_accessor :reward_programs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['reward_programs'] = 'rewardPrograms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        reward_programs
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, reward_programs: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      @reward_programs = reward_programs unless reward_programs == 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.
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      reward_programs = nil
+      unless hash['rewardPrograms'].nil?
+        reward_programs = []
+        hash['rewardPrograms'].each do |structure|
+          reward_programs << (RewardProgramEntity.from_hash(structure) if structure)
+        end
+      end
+
+      reward_programs = SKIP unless hash.key?('rewardPrograms')
+
+      # 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.
+      RewardProgramsEntity.new(page: page,
+                               links: links,
+                               reward_programs: reward_programs,
+                               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} page: #{@page}, links: #{@links}, reward_programs: #{@reward_programs},"\
+      " 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} page: #{@page.inspect}, links: #{@links.inspect}, reward_programs:"\
+      " #{@reward_programs.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/reward_type.rb

@@ -0,0 +1,30 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of the reward balance.  Example: a reward program awarding "Stars"
+  # for purchases would use the `POINTS` reward type.   * `CASHBACK`: Rewards
+  # balances enumerated using a monetary amount   * `MILES`: Rewards balances
+  # enumerated using distance   * `POINTS`: Default when a reward balance is not
+  # of type CASHBACK or MILES
+  class RewardType
+    REWARD_TYPE = [
+      # TODO: Write general description for CASHBACK
+      CASHBACK = 'CASHBACK'.freeze,
+
+      # TODO: Write general description for MILES
+      MILES = 'MILES'.freeze,
+
+      # TODO: Write general description for POINTS
+      POINTS = 'POINTS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/reward_type2.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of the reward balance - CASHBACK, MILES, POINTS
+  class RewardType2
+    REWARD_TYPE2 = [
+      # TODO: Write general description for CASHBACK
+      CASHBACK = 'CASHBACK'.freeze,
+
+      # TODO: Write general description for MILES
+      MILES = 'MILES'.freeze,
+
+      # TODO: Write general description for POINTS
+      POINTS = 'POINTS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end