fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/paystub_entity1.rb

@@ -0,0 +1,104 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # PDF file of a single paystub
+  class PaystubEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The paystub identification number requested. This can be any ID which the
+    # data provider creates specific to the consenting person's paystub, perhaps
+    # simply the pay date as a string optionally followed by a sequence number:
+    # "2024-09-30-01". Need only be unique within the current employee's consent
+    # / token, according to data provider's preference
+    # @return [String]
+    attr_accessor :paystub_id
+
+    # The Base64-encoded content of the paystub PDF file
+    # @return [Binary]
+    attr_accessor :paystub_pdf
+
+    # Whether the paystub PDF also contains an embedded JSON payload of the
+    # Paystub data. That should include three custom properties: `fdxVersion`
+    # containing the version number of the FDX release, `fdxSoftwareId` if
+    # software creating the embedded data is registered with FDX, and `fdxJson`
+    # containing the JSON payload matching the Paystub entity defined here
+    # @return [TrueClass | FalseClass]
+    attr_accessor :embedded_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['paystub_id'] = 'paystubId'
+      @_hash['paystub_pdf'] = 'paystubPdf'
+      @_hash['embedded_data'] = 'embeddedData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        paystub_id
+        paystub_pdf
+        embedded_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(paystub_id: SKIP, paystub_pdf: SKIP, embedded_data: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @paystub_id = paystub_id unless paystub_id == SKIP
+      @paystub_pdf = paystub_pdf unless paystub_pdf == SKIP
+      @embedded_data = embedded_data unless embedded_data == 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.
+      paystub_id = hash.key?('paystubId') ? hash['paystubId'] : SKIP
+      paystub_pdf = hash.key?('paystubPdf') ? hash['paystubPdf'] : SKIP
+      embedded_data = hash.key?('embeddedData') ? hash['embeddedData'] : 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.
+      PaystubEntity1.new(paystub_id: paystub_id,
+                         paystub_pdf: paystub_pdf,
+                         embedded_data: embedded_data,
+                         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} paystub_id: #{@paystub_id}, paystub_pdf: #{@paystub_pdf}, embedded_data:"\
+      " #{@embedded_data}, 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} paystub_id: #{@paystub_id.inspect}, paystub_pdf: #{@paystub_pdf.inspect},"\
+      " embedded_data: #{@embedded_data.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/paystub_entity2.rb

@@ -0,0 +1,105 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # JSON response containing Base64-encoded PaystubPdf content if not encrypted,
+  # or as the JSON payload which is encrypted for an application/jwt response
+  class PaystubEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The paystub identification number requested. This can be any ID which the
+    # data provider creates specific to the consenting person's paystub, perhaps
+    # simply the pay date as a string optionally followed by a sequence number:
+    # "2024-09-30-01". Need only be unique within the current employee's consent
+    # / token, according to data provider's preference
+    # @return [String]
+    attr_accessor :paystub_id
+
+    # The Base64-encoded content of the paystub PDF file
+    # @return [Binary]
+    attr_accessor :paystub_pdf
+
+    # Whether the paystub PDF also contains an embedded JSON payload of the
+    # Paystub data. That should include three custom properties: `fdxVersion`
+    # containing the version number of the FDX release, `fdxSoftwareId` if
+    # software creating the embedded data is registered with FDX, and `fdxJson`
+    # containing the JSON payload matching the Paystub entity defined here
+    # @return [TrueClass | FalseClass]
+    attr_accessor :embedded_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['paystub_id'] = 'paystubId'
+      @_hash['paystub_pdf'] = 'paystubPdf'
+      @_hash['embedded_data'] = 'embeddedData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        paystub_id
+        paystub_pdf
+        embedded_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(paystub_id: SKIP, paystub_pdf: SKIP, embedded_data: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @paystub_id = paystub_id unless paystub_id == SKIP
+      @paystub_pdf = paystub_pdf unless paystub_pdf == SKIP
+      @embedded_data = embedded_data unless embedded_data == 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.
+      paystub_id = hash.key?('paystubId') ? hash['paystubId'] : SKIP
+      paystub_pdf = hash.key?('paystubPdf') ? hash['paystubPdf'] : SKIP
+      embedded_data = hash.key?('embeddedData') ? hash['embeddedData'] : 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.
+      PaystubEntity2.new(paystub_id: paystub_id,
+                         paystub_pdf: paystub_pdf,
+                         embedded_data: embedded_data,
+                         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} paystub_id: #{@paystub_id}, paystub_pdf: #{@paystub_pdf}, embedded_data:"\
+      " #{@embedded_data}, 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} paystub_id: #{@paystub_id.inspect}, paystub_pdf: #{@paystub_pdf.inspect},"\
+      " embedded_data: #{@embedded_data.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/paystub_list_entity.rb

@@ -0,0 +1,104 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Response object for /payroll/paystubs API with list of paystubs retrieved
+  class PaystubListEntity < 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
+
+    # Zero or more Paystubs found within the startTime to endTime range
+    # @return [Array[PaystubEntity]]
+    attr_accessor :paystubs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['paystubs'] = 'paystubs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        paystubs
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, paystubs: 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
+      @paystubs = paystubs unless paystubs == 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
+      paystubs = nil
+      unless hash['paystubs'].nil?
+        paystubs = []
+        hash['paystubs'].each do |structure|
+          paystubs << (PaystubEntity.from_hash(structure) if structure)
+        end
+      end
+
+      paystubs = SKIP unless hash.key?('paystubs')
+
+      # 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.
+      PaystubListEntity.new(page: page,
+                            links: links,
+                            paystubs: paystubs,
+                            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}, paystubs: #{@paystubs},"\
+      " 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}, paystubs:"\
+      " #{@paystubs.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/paystub_list_entity1.rb

@@ -0,0 +1,105 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Array of PaystubList as a JSON response if not encrypted, or as the JSON
+  # payload which is encrypted for an application/jwt response
+  class PaystubListEntity1 < 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
+
+    # Zero or more Paystubs found within the startTime to endTime range
+    # @return [Array[PaystubEntity]]
+    attr_accessor :paystubs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['paystubs'] = 'paystubs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        paystubs
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, paystubs: 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
+      @paystubs = paystubs unless paystubs == 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
+      paystubs = nil
+      unless hash['paystubs'].nil?
+        paystubs = []
+        hash['paystubs'].each do |structure|
+          paystubs << (PaystubEntity.from_hash(structure) if structure)
+        end
+      end
+
+      paystubs = SKIP unless hash.key?('paystubs')
+
+      # 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.
+      PaystubListEntity1.new(page: page,
+                             links: links,
+                             paystubs: paystubs,
+                             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}, paystubs: #{@paystubs},"\
+      " 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}, paystubs:"\
+      " #{@paystubs.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/paystub_source.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The source of the paystub data, PAYROLL_PROCESSOR, EMPLOYER, or THIRD_PARTY
+  class PaystubSource
+    PAYSTUB_SOURCE = [
+      # TODO: Write general description for EMPLOYER
+      EMPLOYER = 'EMPLOYER'.freeze,
+
+      # TODO: Write general description for PAYROLL_PROCESSOR
+      PAYROLL_PROCESSOR = 'PAYROLL_PROCESSOR'.freeze,
+
+      # TODO: Write general description for THIRD_PARTY
+      THIRD_PARTY = 'THIRD_PARTY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = EMPLOYER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'employer' then EMPLOYER
+      when 'payroll_processor' then PAYROLL_PROCESSOR
+      when 'third_party' then THIRD_PARTY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/paystub_source2.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The original source of the paystub data
+  class PaystubSource2
+    PAYSTUB_SOURCE2 = [
+      # TODO: Write general description for EMPLOYER
+      EMPLOYER = 'EMPLOYER'.freeze,
+
+      # TODO: Write general description for PAYROLL_PROCESSOR
+      PAYROLL_PROCESSOR = 'PAYROLL_PROCESSOR'.freeze,
+
+      # TODO: Write general description for THIRD_PARTY
+      THIRD_PARTY = 'THIRD_PARTY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = EMPLOYER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'employer' then EMPLOYER
+      when 'payroll_processor' then PAYROLL_PROCESSOR
+      when 'third_party' then THIRD_PARTY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/pension_source_entity.rb

@@ -0,0 +1,136 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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
+
+    # Defines how often the pension payment repeats
+    # @return [EventFrequency1]
+    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_v660_api/models/period_certain_type.rb

@@ -0,0 +1,52 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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
+
+    def self.from_value(value, default_value = ENUM_5_YEAR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_5_year' then ENUM_5_YEAR
+      when 'enum_10_year' then ENUM_10_YEAR
+      when 'enum_20_year' then ENUM_20_YEAR
+      when 'enum_30_year' then ENUM_30_YEAR
+      when 'none' then NONE
+      else
+        default_value
+      end
+    end
+  end
+end