fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payroll_report_entity.rb

@@ -0,0 +1,162 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An employee's Payroll Report
+  class PayrollReportEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The report identification number
+    # @return [String]
+    attr_accessor :report_id
+
+    # The type of report
+    # @return [PayrollReportType1]
+    attr_accessor :report_type
+
+    # The generation date of the report
+    # @return [Date]
+    attr_accessor :generation_date
+
+    # The data in the report is as of this date.
+    # @return [Date]
+    attr_accessor :data_as_of
+
+    # The employee
+    # @return [EmployeeEntity1]
+    attr_accessor :employee
+
+    # The employee's employment
+    # @return [Employment1]
+    attr_accessor :employment
+
+    # The employee's year to date income amounts for current and previous years
+    # omitted for Verification of Employment requests (VOE), included for
+    # Verification of Income and Employment requests (VOI / VOIE)
+    # @return [Array[Income]]
+    attr_accessor :incomes
+
+    # Links to retrieve this payroll report, or to invoke related APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['report_id'] = 'reportId'
+      @_hash['report_type'] = 'reportType'
+      @_hash['generation_date'] = 'generationDate'
+      @_hash['data_as_of'] = 'dataAsOf'
+      @_hash['employee'] = 'employee'
+      @_hash['employment'] = 'employment'
+      @_hash['incomes'] = 'incomes'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data_as_of
+        incomes
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(report_id:, report_type:, generation_date:, employee:,
+                   employment:, data_as_of: SKIP, incomes: SKIP, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @report_id = report_id
+      @report_type = report_type
+      @generation_date = generation_date
+      @data_as_of = data_as_of unless data_as_of == SKIP
+      @employee = employee
+      @employment = employment
+      @incomes = incomes unless incomes == SKIP
+      @links = links unless links == 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.
+      report_id = hash.key?('reportId') ? hash['reportId'] : nil
+      report_type = hash.key?('reportType') ? hash['reportType'] : nil
+      generation_date =
+        hash.key?('generationDate') ? hash['generationDate'] : nil
+      employee = EmployeeEntity1.from_hash(hash['employee']) if hash['employee']
+      employment = Employment1.from_hash(hash['employment']) if hash['employment']
+      data_as_of = hash.key?('dataAsOf') ? hash['dataAsOf'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      incomes = nil
+      unless hash['incomes'].nil?
+        incomes = []
+        hash['incomes'].each do |structure|
+          incomes << (Income.from_hash(structure) if structure)
+        end
+      end
+
+      incomes = SKIP unless hash.key?('incomes')
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('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.
+      PayrollReportEntity.new(report_id: report_id,
+                              report_type: report_type,
+                              generation_date: generation_date,
+                              employee: employee,
+                              employment: employment,
+                              data_as_of: data_as_of,
+                              incomes: incomes,
+                              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} report_id: #{@report_id}, report_type: #{@report_type}, generation_date:"\
+      " #{@generation_date}, data_as_of: #{@data_as_of}, employee: #{@employee}, employment:"\
+      " #{@employment}, incomes: #{@incomes}, links: #{@links}, 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} report_id: #{@report_id.inspect}, report_type: #{@report_type.inspect},"\
+      " generation_date: #{@generation_date.inspect}, data_as_of: #{@data_as_of.inspect},"\
+      " employee: #{@employee.inspect}, employment: #{@employment.inspect}, incomes:"\
+      " #{@incomes.inspect}, links: #{@links.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payroll_report_list_entity.rb

@@ -0,0 +1,103 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Response object for /payroll/report API with list of reports available
+  class PayrollReportListEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Zero or more PayrollReportSummaries for lightweight response
+    # @return [Array[PayrollReportSummaryEntity]]
+    attr_accessor :summaries
+
+    # Zero or more PayrollReports, for details response
+    # @return [Array[PayrollReportEntity]]
+    attr_accessor :reports
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['summaries'] = 'summaries'
+      @_hash['reports'] = 'reports'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        summaries
+        reports
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(summaries: SKIP, reports: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @summaries = summaries unless summaries == SKIP
+      @reports = reports unless reports == 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.
+      # Parameter is an array, so we need to iterate through it
+      summaries = nil
+      unless hash['summaries'].nil?
+        summaries = []
+        hash['summaries'].each do |structure|
+          summaries << (PayrollReportSummaryEntity.from_hash(structure) if structure)
+        end
+      end
+
+      summaries = SKIP unless hash.key?('summaries')
+      # Parameter is an array, so we need to iterate through it
+      reports = nil
+      unless hash['reports'].nil?
+        reports = []
+        hash['reports'].each do |structure|
+          reports << (PayrollReportEntity.from_hash(structure) if structure)
+        end
+      end
+
+      reports = SKIP unless hash.key?('reports')
+
+      # 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.
+      PayrollReportListEntity.new(summaries: summaries,
+                                  reports: reports,
+                                  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} summaries: #{@summaries}, reports: #{@reports}, 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} summaries: #{@summaries.inspect}, reports: #{@reports.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payroll_report_summary_entity.rb

@@ -0,0 +1,160 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The list of payroll reports for an employee
+  class PayrollReportSummaryEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The report identification number
+    # @return [String]
+    attr_accessor :report_id
+
+    # The type of report
+    # @return [PayrollReportType1]
+    attr_accessor :report_type
+
+    # The generation date of the report
+    # @return [Date]
+    attr_accessor :generation_date
+
+    # The data in the report is as of this date.
+    # @return [Date]
+    attr_accessor :data_as_of
+
+    # Provider's long-term persistent id for the employee
+    # @return [String]
+    attr_accessor :employee_id
+
+    # Employee's full name
+    # @return [IndividualName]
+    attr_accessor :employee_name
+
+    # The employer for this report
+    # @return [String]
+    attr_accessor :employer_id
+
+    # The employer's name
+    # @return [BusinessName]
+    attr_accessor :employer_name
+
+    # Links to retrieve this payroll report, or to invoke related APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['report_id'] = 'reportId'
+      @_hash['report_type'] = 'reportType'
+      @_hash['generation_date'] = 'generationDate'
+      @_hash['data_as_of'] = 'dataAsOf'
+      @_hash['employee_id'] = 'employeeId'
+      @_hash['employee_name'] = 'employeeName'
+      @_hash['employer_id'] = 'employerId'
+      @_hash['employer_name'] = 'employerName'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data_as_of
+        employee_id
+        employer_id
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(report_id:, report_type:, generation_date:, employee_name:,
+                   employer_name:, data_as_of: SKIP, employee_id: SKIP,
+                   employer_id: SKIP, links: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @report_id = report_id
+      @report_type = report_type
+      @generation_date = generation_date
+      @data_as_of = data_as_of unless data_as_of == SKIP
+      @employee_id = employee_id unless employee_id == SKIP
+      @employee_name = employee_name
+      @employer_id = employer_id unless employer_id == SKIP
+      @employer_name = employer_name
+      @links = links unless links == 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.
+      report_id = hash.key?('reportId') ? hash['reportId'] : nil
+      report_type = hash.key?('reportType') ? hash['reportType'] : nil
+      generation_date =
+        hash.key?('generationDate') ? hash['generationDate'] : nil
+      employee_name = IndividualName.from_hash(hash['employeeName']) if hash['employeeName']
+      employer_name = BusinessName.from_hash(hash['employerName']) if hash['employerName']
+      data_as_of = hash.key?('dataAsOf') ? hash['dataAsOf'] : SKIP
+      employee_id = hash.key?('employeeId') ? hash['employeeId'] : SKIP
+      employer_id = hash.key?('employerId') ? hash['employerId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('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.
+      PayrollReportSummaryEntity.new(report_id: report_id,
+                                     report_type: report_type,
+                                     generation_date: generation_date,
+                                     employee_name: employee_name,
+                                     employer_name: employer_name,
+                                     data_as_of: data_as_of,
+                                     employee_id: employee_id,
+                                     employer_id: employer_id,
+                                     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} report_id: #{@report_id}, report_type: #{@report_type}, generation_date:"\
+      " #{@generation_date}, data_as_of: #{@data_as_of}, employee_id: #{@employee_id},"\
+      " employee_name: #{@employee_name}, employer_id: #{@employer_id}, employer_name:"\
+      " #{@employer_name}, links: #{@links}, 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} report_id: #{@report_id.inspect}, report_type: #{@report_type.inspect},"\
+      " generation_date: #{@generation_date.inspect}, data_as_of: #{@data_as_of.inspect},"\
+      " employee_id: #{@employee_id.inspect}, employee_name: #{@employee_name.inspect},"\
+      " employer_id: #{@employer_id.inspect}, employer_name: #{@employer_name.inspect}, links:"\
+      " #{@links.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payroll_report_type.rb

@@ -0,0 +1,24 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of payroll report, VOE - for Verification of Employment, VOIE - for
+  # Verification of Income and Employment
+  class PayrollReportType
+    PAYROLL_REPORT_TYPE = [
+      # TODO: Write general description for VOE
+      VOE = 'VOE'.freeze,
+
+      # TODO: Write general description for VOIE
+      VOIE = 'VOIE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payroll_report_type1.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of report
+  class PayrollReportType1
+    PAYROLL_REPORT_TYPE1 = [
+      # TODO: Write general description for VOE
+      VOE = 'VOE'.freeze,
+
+      # TODO: Write general description for VOIE
+      VOIE = 'VOIE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/pension_source_entity.rb

@@ -0,0 +1,136 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The source of pension funds
+  class PensionSourceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the source
+    # @return [String]
+    attr_accessor :display_name
+
+    # Benefit Amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Form of payment
+    # @return [String]
+    attr_accessor :payment_option
+
+    # Date benefit was calculated
+    # @return [Date]
+    attr_accessor :as_of_date
+
+    # ANNUALLY, BIWEEKLY, DAILY, MONTHLY, SEMIANNUALLY, SEMIMONTHLY, WEEKLY
+    # @return [PaymentFrequency3]
+    attr_accessor :frequency
+
+    # Assumed retirement date. As of date amount is payable
+    # @return [Date]
+    attr_accessor :start_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'displayName'
+      @_hash['amount'] = 'amount'
+      @_hash['payment_option'] = 'paymentOption'
+      @_hash['as_of_date'] = 'asOfDate'
+      @_hash['frequency'] = 'frequency'
+      @_hash['start_date'] = 'startDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        amount
+        payment_option
+        as_of_date
+        frequency
+        start_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(display_name: SKIP, amount: SKIP, payment_option: SKIP,
+                   as_of_date: SKIP, frequency: SKIP, start_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @display_name = display_name unless display_name == SKIP
+      @amount = amount unless amount == SKIP
+      @payment_option = payment_option unless payment_option == SKIP
+      @as_of_date = as_of_date unless as_of_date == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @start_date = start_date unless start_date == 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.
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      payment_option = hash.key?('paymentOption') ? hash['paymentOption'] : SKIP
+      as_of_date = hash.key?('asOfDate') ? hash['asOfDate'] : SKIP
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      start_date = hash.key?('startDate') ? hash['startDate'] : 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.
+      PensionSourceEntity.new(display_name: display_name,
+                              amount: amount,
+                              payment_option: payment_option,
+                              as_of_date: as_of_date,
+                              frequency: frequency,
+                              start_date: start_date,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PensionSourceEntity | 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} display_name: #{@display_name}, amount: #{@amount}, payment_option:"\
+      " #{@payment_option}, as_of_date: #{@as_of_date}, frequency: #{@frequency}, start_date:"\
+      " #{@start_date}, 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} display_name: #{@display_name.inspect}, amount: #{@amount.inspect},"\
+      " payment_option: #{@payment_option.inspect}, as_of_date: #{@as_of_date.inspect}, frequency:"\
+      " #{@frequency.inspect}, start_date: #{@start_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/period_certain_type.rb

@@ -0,0 +1,36 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The number of modal periods comprising the duration of the certain period of
+  # an annuity payout.   | Value | Description |   |-----|-----|   | 5_YEAR |
+  # Five year duration |   | 10_YEAR | Ten year duration |   | 20_YEAR | Twenty
+  # year duration |   | 30_YEAR | Thirty year duration |   | NONE | Not a Period
+  # Certain |
+  class PeriodCertainType
+    PERIOD_CERTAIN_TYPE = [
+      # TODO: Write general description for ENUM_5_YEAR
+      ENUM_5_YEAR = '5_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_10_YEAR
+      ENUM_10_YEAR = '10_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_20_YEAR
+      ENUM_20_YEAR = '20_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_30_YEAR
+      ENUM_30_YEAR = '30_YEAR'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/period_certain_type2.rb

@@ -0,0 +1,33 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The number of modal periods comprising the duration of the certain period of
+  # an annuity payout
+  class PeriodCertainType2
+    PERIOD_CERTAIN_TYPE2 = [
+      # TODO: Write general description for ENUM_5_YEAR
+      ENUM_5_YEAR = '5_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_10_YEAR
+      ENUM_10_YEAR = '10_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_20_YEAR
+      ENUM_20_YEAR = '20_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_30_YEAR
+      ENUM_30_YEAR = '30_YEAR'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end