fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/party_type.rb

@@ -0,0 +1,35 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Extensible string enum identifying the type of the party
+  class PartyType
+    PARTY_TYPE = [
+      # TODO: Write general description for DATA_ACCESS_PLATFORM
+      DATA_ACCESS_PLATFORM = 'DATA_ACCESS_PLATFORM'.freeze,
+
+      # TODO: Write general description for DATA_PROVIDER
+      DATA_PROVIDER = 'DATA_PROVIDER'.freeze,
+
+      # TODO: Write general description for DATA_RECIPIENT
+      DATA_RECIPIENT = 'DATA_RECIPIENT'.freeze,
+
+      # TODO: Write general description for INDIVIDUAL
+      INDIVIDUAL = 'INDIVIDUAL'.freeze,
+
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for VENDOR
+      VENDOR = 'VENDOR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/party_type1.rb

@@ -0,0 +1,35 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The party initiating consent revocation
+  class PartyType1
+    PARTY_TYPE1 = [
+      # TODO: Write general description for DATA_ACCESS_PLATFORM
+      DATA_ACCESS_PLATFORM = 'DATA_ACCESS_PLATFORM'.freeze,
+
+      # TODO: Write general description for DATA_PROVIDER
+      DATA_PROVIDER = 'DATA_PROVIDER'.freeze,
+
+      # TODO: Write general description for DATA_RECIPIENT
+      DATA_RECIPIENT = 'DATA_RECIPIENT'.freeze,
+
+      # TODO: Write general description for INDIVIDUAL
+      INDIVIDUAL = 'INDIVIDUAL'.freeze,
+
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for VENDOR
+      VENDOR = 'VENDOR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/party_type2.rb

@@ -0,0 +1,35 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The party initiating revocation
+  class PartyType2
+    PARTY_TYPE2 = [
+      # TODO: Write general description for DATA_ACCESS_PLATFORM
+      DATA_ACCESS_PLATFORM = 'DATA_ACCESS_PLATFORM'.freeze,
+
+      # TODO: Write general description for DATA_PROVIDER
+      DATA_PROVIDER = 'DATA_PROVIDER'.freeze,
+
+      # TODO: Write general description for DATA_RECIPIENT
+      DATA_RECIPIENT = 'DATA_RECIPIENT'.freeze,
+
+      # TODO: Write general description for INDIVIDUAL
+      INDIVIDUAL = 'INDIVIDUAL'.freeze,
+
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # TODO: Write general description for VENDOR
+      VENDOR = 'VENDOR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payee_entity.rb

@@ -0,0 +1,75 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Payee to whom funds can be transferred. Can be extended to support
+  # additional types of payees
+  class PayeeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When payee is a merchant, typically a business from which goods or
+    # services are rendered, this field will be populated
+    # @return [MerchantEntity1]
+    attr_accessor :merchant
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant'] = 'merchant'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @merchant = merchant
+      @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.
+      merchant = MerchantEntity1.from_hash(hash['merchant']) if hash['merchant']
+
+      # 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.
+      PayeeEntity.new(merchant: merchant,
+                      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} merchant: #{@merchant}, 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} merchant: #{@merchant.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payee_for_update_entity.rb

@@ -0,0 +1,74 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Payee's fields to be updated
+  class PayeeForUpdateEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When payee is a merchant, typically a business from which goods or
+    # services are rendered, this field will be populated
+    # @return [MerchantForUpdateEntity1]
+    attr_accessor :merchant
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant'] = 'merchant'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @merchant = merchant
+      @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.
+      merchant = MerchantForUpdateEntity1.from_hash(hash['merchant']) if hash['merchant']
+
+      # 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.
+      PayeeForUpdateEntity.new(merchant: merchant,
+                               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} merchant: #{@merchant}, 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} merchant: #{@merchant.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payee_for_update_entity1.rb

@@ -0,0 +1,74 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The data of the Payee to be updated
+  class PayeeForUpdateEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When payee is a merchant, typically a business from which goods or
+    # services are rendered, this field will be populated
+    # @return [MerchantForUpdateEntity1]
+    attr_accessor :merchant
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant'] = 'merchant'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @merchant = merchant
+      @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.
+      merchant = MerchantForUpdateEntity1.from_hash(hash['merchant']) if hash['merchant']
+
+      # 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.
+      PayeeForUpdateEntity1.new(merchant: merchant,
+                                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} merchant: #{@merchant}, 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} merchant: #{@merchant.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payees_entity.rb

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

data/lib/fdx_api/models/payment_amounts.rb

@@ -0,0 +1,133 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Year to date amounts for current and previous years
+  class PaymentAmounts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total gross pay for covered period
+    # @return [MonetaryAmount1]
+    attr_accessor :total
+
+    # Base pay part of Gross pay for covered period
+    # @return [MonetaryAmount2]
+    attr_accessor :base
+
+    # Bonus pay for covered period
+    # @return [MonetaryAmount3]
+    attr_accessor :bonus
+
+    # Commission for covered period
+    # @return [MonetaryAmount4]
+    attr_accessor :commission
+
+    # Overtime pay for covered period
+    # @return [MonetaryAmount5]
+    attr_accessor :overtime
+
+    # Other earnings received in covered period
+    # @return [Array[OtherMonetaryAmount]]
+    attr_accessor :other_earnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total'] = 'total'
+      @_hash['base'] = 'base'
+      @_hash['bonus'] = 'bonus'
+      @_hash['commission'] = 'commission'
+      @_hash['overtime'] = 'overtime'
+      @_hash['other_earnings'] = 'otherEarnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        base
+        bonus
+        commission
+        overtime
+        other_earnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total:, base: SKIP, bonus: SKIP, commission: SKIP,
+                   overtime: SKIP, other_earnings: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total = total
+      @base = base unless base == SKIP
+      @bonus = bonus unless bonus == SKIP
+      @commission = commission unless commission == SKIP
+      @overtime = overtime unless overtime == SKIP
+      @other_earnings = other_earnings unless other_earnings == 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.
+      total = MonetaryAmount1.from_hash(hash['total']) if hash['total']
+      base = MonetaryAmount2.from_hash(hash['base']) if hash['base']
+      bonus = MonetaryAmount3.from_hash(hash['bonus']) if hash['bonus']
+      commission = MonetaryAmount4.from_hash(hash['commission']) if hash['commission']
+      overtime = MonetaryAmount5.from_hash(hash['overtime']) if hash['overtime']
+      # Parameter is an array, so we need to iterate through it
+      other_earnings = nil
+      unless hash['otherEarnings'].nil?
+        other_earnings = []
+        hash['otherEarnings'].each do |structure|
+          other_earnings << (OtherMonetaryAmount.from_hash(structure) if structure)
+        end
+      end
+
+      other_earnings = SKIP unless hash.key?('otherEarnings')
+
+      # 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.
+      PaymentAmounts.new(total: total,
+                         base: base,
+                         bonus: bonus,
+                         commission: commission,
+                         overtime: overtime,
+                         other_earnings: other_earnings,
+                         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} total: #{@total}, base: #{@base}, bonus: #{@bonus}, commission:"\
+      " #{@commission}, overtime: #{@overtime}, other_earnings: #{@other_earnings},"\
+      " 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} total: #{@total.inspect}, base: #{@base.inspect}, bonus: #{@bonus.inspect},"\
+      " commission: #{@commission.inspect}, overtime: #{@overtime.inspect}, other_earnings:"\
+      " #{@other_earnings.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_amounts1.rb

@@ -0,0 +1,92 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Year-to-date pay for current year and total annual pay for previous years
+  class PaymentAmounts1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The year in which this income was earned
+    # @return [Integer]
+    attr_accessor :year
+
+    # Gross pay for covered period
+    # @return [PaymentAmounts2]
+    attr_accessor :gross_pay
+
+    # Net pay for covered period
+    # @return [MonetaryAmount6]
+    attr_accessor :net_pay
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['year'] = 'year'
+      @_hash['gross_pay'] = 'grossPay'
+      @_hash['net_pay'] = 'netPay'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        net_pay
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(year:, gross_pay:, net_pay: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @year = year
+      @gross_pay = gross_pay
+      @net_pay = net_pay unless net_pay == 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.
+      year = hash.key?('year') ? hash['year'] : nil
+      gross_pay = PaymentAmounts2.from_hash(hash['grossPay']) if hash['grossPay']
+      net_pay = MonetaryAmount6.from_hash(hash['netPay']) if hash['netPay']
+
+      # 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.
+      PaymentAmounts1.new(year: year,
+                          gross_pay: gross_pay,
+                          net_pay: net_pay,
+                          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} year: #{@year}, gross_pay: #{@gross_pay}, net_pay: #{@net_pay},"\
+      " 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} year: #{@year.inspect}, gross_pay: #{@gross_pay.inspect}, net_pay:"\
+      " #{@net_pay.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end