fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/reward_balance_entity.rb

@@ -0,0 +1,154 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Reward program balance
+  class RewardBalanceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name used to denominate the balance
+    # @return [String]
+    attr_accessor :name
+
+    # The type of the reward balance - CASHBACK, MILES, POINTS
+    # @return [RewardType1]
+    attr_accessor :type
+
+    # Total units available for redemption at time of download
+    # @return [Float]
+    attr_accessor :balance
+
+    # Total units accrued in the current program year at time of download
+    # @return [Float]
+    attr_accessor :accrued_ytd
+
+    # Total units redeemed in the current program year at time of download
+    # @return [Float]
+    attr_accessor :redeemed_ytd
+
+    # Balance used for qualifying purposes
+    # @return [TrueClass | FalseClass]
+    attr_accessor :qualifying
+
+    # 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['name'] = 'name'
+      @_hash['type'] = 'type'
+      @_hash['balance'] = 'balance'
+      @_hash['accrued_ytd'] = 'accruedYtd'
+      @_hash['redeemed_ytd'] = 'redeemedYtd'
+      @_hash['qualifying'] = 'qualifying'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        type
+        balance
+        accrued_ytd
+        redeemed_ytd
+        qualifying
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, type: SKIP, balance: SKIP, accrued_ytd: SKIP,
+                   redeemed_ytd: SKIP, qualifying: false, fi_attributes: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @type = type unless type == SKIP
+      @balance = balance unless balance == SKIP
+      @accrued_ytd = accrued_ytd unless accrued_ytd == SKIP
+      @redeemed_ytd = redeemed_ytd unless redeemed_ytd == SKIP
+      @qualifying = qualifying unless qualifying == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      accrued_ytd = hash.key?('accruedYtd') ? hash['accruedYtd'] : SKIP
+      redeemed_ytd = hash.key?('redeemedYtd') ? hash['redeemedYtd'] : SKIP
+      qualifying = hash['qualifying'] ||= false
+      # 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.
+      RewardBalanceEntity.new(name: name,
+                              type: type,
+                              balance: balance,
+                              accrued_ytd: accrued_ytd,
+                              redeemed_ytd: redeemed_ytd,
+                              qualifying: qualifying,
+                              fi_attributes: fi_attributes,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RewardBalanceEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, type: #{@type}, balance: #{@balance}, accrued_ytd:"\
+      " #{@accrued_ytd}, redeemed_ytd: #{@redeemed_ytd}, qualifying: #{@qualifying},"\
+      " 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} name: #{@name.inspect}, type: #{@type.inspect}, balance:"\
+      " #{@balance.inspect}, accrued_ytd: #{@accrued_ytd.inspect}, redeemed_ytd:"\
+      " #{@redeemed_ytd.inspect}, qualifying: #{@qualifying.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/reward_categories_entity.rb

@@ -0,0 +1,104 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An optionally paginated array of reward categories
+  class RewardCategoriesEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Page keys for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks1]
+    attr_accessor :links
+
+    # Array of reward categories
+    # @return [Array[RewardCategoryEntity]]
+    attr_accessor :reward_categories
+
+    # 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_categories'] = 'rewardCategories'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        reward_categories
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, reward_categories: 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_categories = reward_categories unless reward_categories == 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 = PageMetadataLinks1.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      reward_categories = nil
+      unless hash['rewardCategories'].nil?
+        reward_categories = []
+        hash['rewardCategories'].each do |structure|
+          reward_categories << (RewardCategoryEntity.from_hash(structure) if structure)
+        end
+      end
+
+      reward_categories = SKIP unless hash.key?('rewardCategories')
+
+      # 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.
+      RewardCategoriesEntity.new(page: page,
+                                 links: links,
+                                 reward_categories: reward_categories,
+                                 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_categories: #{@reward_categories},"\
+      " 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_categories:"\
+      " #{@reward_categories.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/reward_category_entity.rb

@@ -0,0 +1,136 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Reward category used to calculate rewards on a transaction
+  class RewardCategoryEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long term persistent identity of the reward program
+    # @return [String]
+    attr_accessor :reward_program_id
+
+    # Reward category name
+    # @return [String]
+    attr_accessor :category_name
+
+    # Long term persistent identity of the reward category
+    # @return [String]
+    attr_accessor :category_id
+
+    # Factor used to calculate rewards accrued
+    # @return [Float]
+    attr_accessor :multiplier
+
+    # Description of the reward category
+    # @return [String]
+    attr_accessor :description
+
+    # 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['category_name'] = 'categoryName'
+      @_hash['category_id'] = 'categoryId'
+      @_hash['multiplier'] = 'multiplier'
+      @_hash['description'] = 'description'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reward_program_id
+        category_name
+        category_id
+        multiplier
+        description
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reward_program_id: SKIP, category_name: SKIP,
+                   category_id: SKIP, multiplier: SKIP, description: 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
+      @category_name = category_name unless category_name == SKIP
+      @category_id = category_id unless category_id == SKIP
+      @multiplier = multiplier unless multiplier == SKIP
+      @description = description unless description == 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
+      category_name = hash.key?('categoryName') ? hash['categoryName'] : SKIP
+      category_id = hash.key?('categoryId') ? hash['categoryId'] : SKIP
+      multiplier = hash.key?('multiplier') ? hash['multiplier'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # 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.
+      RewardCategoryEntity.new(reward_program_id: reward_program_id,
+                               category_name: category_name,
+                               category_id: category_id,
+                               multiplier: multiplier,
+                               description: description,
+                               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}, category_name: #{@category_name},"\
+      " category_id: #{@category_id}, multiplier: #{@multiplier}, description: #{@description},"\
+      " 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}, category_name:"\
+      " #{@category_name.inspect}, category_id: #{@category_id.inspect}, multiplier:"\
+      " #{@multiplier.inspect}, description: #{@description.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/reward_program_entity.rb

@@ -0,0 +1,136 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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_v660_api/models/reward_program_membership_entity.rb

@@ -0,0 +1,158 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Details of a single membership in a reward programs
+  class RewardProgramMembershipEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of accountIds associated to the reward program. Deprecated in
+    # release v6.5 in favor of single `accountId` for these balances
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # A single accountId associated to the reward program
+    # @return [String]
+    attr_accessor :account_id
+
+    # 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['account_id'] = 'accountId'
+      @_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
+        account_id
+        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, account_id: 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
+      @account_id = account_id unless account_id == 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
+      account_id = hash.key?('accountId') ? hash['accountId'] : 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,
+                                        account_id: account_id,
+                                        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}, account_id: #{@account_id}, 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}, account_id: #{@account_id.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