fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/resource_list_entity.rb

@@ -0,0 +1,104 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Response object for /resources API
+  class ResourceListEntity < 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
+
+    # Zero or more Resources
+    # @return [Array[ResourceEntity]]
+    attr_accessor :resources
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['resources'] = 'resources'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        resources
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, resources: 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
+      @resources = resources unless resources == 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
+      resources = nil
+      unless hash['resources'].nil?
+        resources = []
+        hash['resources'].each do |structure|
+          resources << (ResourceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      resources = SKIP unless hash.key?('resources')
+
+      # 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.
+      ResourceListEntity.new(page: page,
+                             links: links,
+                             resources: resources,
+                             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}, resources: #{@resources},"\
+      " 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}, resources:"\
+      " #{@resources.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/resource_status.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Statuses for resource
+  class ResourceStatus
+    RESOURCE_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for IN_PROGRESS
+      IN_PROGRESS = 'IN_PROGRESS'.freeze,
+
+      # TODO: Write general description for RETIRED
+      RETIRED = 'RETIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/resource_status2.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Status of Resource
+  class ResourceStatus2
+    RESOURCE_STATUS2 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for IN_PROGRESS
+      IN_PROGRESS = 'IN_PROGRESS'.freeze,
+
+      # TODO: Write general description for RETIRED
+      RETIRED = 'RETIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/result_type.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Flag to indicate if you want a lightweight array of metadata
+  # (AccountDescriptor or Tax or Operations) or full item details (Account or a
+  # Tax subclass or Availability details). If set to 'lightweight', should only
+  # return the fields associated with the metadata entity.
+  class ResultType
+    RESULT_TYPE = [
+      # TODO: Write general description for DETAILS
+      DETAILS = 'details'.freeze,
+
+      # TODO: Write general description for LIGHTWEIGHT
+      LIGHTWEIGHT = 'lightweight'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/reward_balance_entity.rb

@@ -0,0 +1,144 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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 [RewardType2]
+    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
+
+    # 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_api/models/reward_categories_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 categories
+  class RewardCategoriesEntity < 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 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 = PageMetadataLinks.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_api/models/reward_category_entity.rb

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