fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/domicile_entity1.rb

@@ -0,0 +1,97 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The country and region of the business customer's location
+  class DomicileEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country sub-division; state or province or territory. For U.S. addresses
+    # can be a 2-character code from `StateCode`. For Canadian addresses can be
+    # a 2-character code from `ProvinceTerritoryCode`
+    # @return [String]
+    attr_accessor :region
+
+    # ISO 3166 Country Code
+    # @return [Iso3166CountryCode7]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['region'] = 'region'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        region
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(region: SKIP, country: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @region = region unless region == SKIP
+      @country = country unless country == 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.
+      region = hash.key?('region') ? hash['region'] : SKIP
+      country = hash.key?('country') ? hash['country'] : 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.
+      DomicileEntity1.new(region: region,
+                          country: country,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DomicileEntity1 | 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} region: #{@region}, country: #{@country}, 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} region: #{@region.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/domicile_entity3.rb

@@ -0,0 +1,97 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The country and region of the account's legal jurisdiction
+  class DomicileEntity3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Country sub-division; state or province or territory. For U.S. addresses
+    # can be a 2-character code from `StateCode`. For Canadian addresses can be
+    # a 2-character code from `ProvinceTerritoryCode`
+    # @return [String]
+    attr_accessor :region
+
+    # ISO 3166 Country Code
+    # @return [Iso3166CountryCode7]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['region'] = 'region'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        region
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(region: SKIP, country: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @region = region unless region == SKIP
+      @country = country unless country == 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.
+      region = hash.key?('region') ? hash['region'] : SKIP
+      country = hash.key?('country') ? hash['country'] : 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.
+      DomicileEntity3.new(region: region,
+                          country: country,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DomicileEntity3 | 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} region: #{@region}, country: #{@country}, 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} region: #{@region.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/earning_component.rb

@@ -0,0 +1,153 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A single named pay component earned on this paystub with amount and optional
+  # currency and/or year-to-date amount. Common names to use for earned
+  # components that would fall under OTHER type (in addition to names for BASE,
+  # BONUS, COMMISSION, and OVERTIME types) are Tips, Stock, Workers
+  # Compensation, Pension, and Severance. (Inheriting properties `amount`,
+  # `currency`, `name` and `yearToDate` from `PayAmount`)
+  class EarningComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode7]
+    attr_accessor :currency
+
+    # Name of this pay element, earning or deduction, if needed
+    # @return [String]
+    attr_accessor :name
+
+    # Year-to-date currency amount for this pay element, earning or deduction,
+    # if relevant
+    # @return [Float]
+    attr_accessor :year_to_date
+
+    # The rate used to calculate this earned component amount
+    # @return [Float]
+    attr_accessor :rate
+
+    # The unit for this rate. In time period length order, one of HOURLY, DAILY,
+    # WEEKLY, BI-WEEKLY, SEMI-MONTHLY, EVERY 2.6 WEEKS, EVERY 4 WEEKS, MONTHLY,
+    # EVERY 5.2 WEEKS, QUARTERLY, SEMI-ANNUALLY, ANNUAL, OTHER
+    # @return [PayrollRateType1]
+    attr_accessor :rate_type
+
+    # The number of hours paid for this component amount
+    # @return [Float]
+    attr_accessor :hours
+
+    # The GSE Mapping for a specific earning component. For a Government
+    # Sponsored Enterprise (GSE), such as Fannie Mae or Freddie Mac. One of
+    # BASE, BONUS, COMMISSION, OTHER, OVERTIME
+    # @return [EarningType]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['name'] = 'name'
+      @_hash['year_to_date'] = 'yearToDate'
+      @_hash['rate'] = 'rate'
+      @_hash['rate_type'] = 'rateType'
+      @_hash['hours'] = 'hours'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        name
+        year_to_date
+        rate
+        rate_type
+        hours
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, name: SKIP, year_to_date: SKIP,
+                   rate: SKIP, rate_type: SKIP, hours: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == SKIP
+      @name = name unless name == SKIP
+      @year_to_date = year_to_date unless year_to_date == SKIP
+      @rate = rate unless rate == SKIP
+      @rate_type = rate_type unless rate_type == SKIP
+      @hours = hours unless hours == SKIP
+      @type = type unless type == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      year_to_date = hash.key?('yearToDate') ? hash['yearToDate'] : SKIP
+      rate = hash.key?('rate') ? hash['rate'] : SKIP
+      rate_type = hash.key?('rateType') ? hash['rateType'] : SKIP
+      hours = hash.key?('hours') ? hash['hours'] : SKIP
+      type = hash.key?('type') ? hash['type'] : 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.
+      EarningComponent.new(amount: amount,
+                           currency: currency,
+                           name: name,
+                           year_to_date: year_to_date,
+                           rate: rate,
+                           rate_type: rate_type,
+                           hours: hours,
+                           type: type,
+                           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} amount: #{@amount}, currency: #{@currency}, name: #{@name}, year_to_date:"\
+      " #{@year_to_date}, rate: #{@rate}, rate_type: #{@rate_type}, hours: #{@hours}, type:"\
+      " #{@type}, 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} amount: #{@amount.inspect}, currency: #{@currency.inspect}, name:"\
+      " #{@name.inspect}, year_to_date: #{@year_to_date.inspect}, rate: #{@rate.inspect},"\
+      " rate_type: #{@rate_type.inspect}, hours: #{@hours.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/earning_type.rb

@@ -0,0 +1,50 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The GSE Mapping for a specific earning component. For a Government Sponsored
+  # Enterprise (GSE), such as Fannie Mae or Freddie Mac. One of BASE, BONUS,
+  # COMMISSION, OTHER, OVERTIME
+  class EarningType
+    EARNING_TYPE = [
+      # TODO: Write general description for BASE
+      BASE = 'BASE'.freeze,
+
+      # TODO: Write general description for BONUS
+      BONUS = 'BONUS'.freeze,
+
+      # TODO: Write general description for COMMISSION
+      COMMISSION = 'COMMISSION'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for OVERTIME
+      OVERTIME = 'OVERTIME'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BASE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'base' then BASE
+      when 'bonus' then BONUS
+      when 'commission' then COMMISSION
+      when 'other' then OTHER
+      when 'overtime' then OVERTIME
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/electronic_address_entity.rb

@@ -0,0 +1,87 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Electronic address details
+  class ElectronicAddressEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Value of the email address
+    # @return [String]
+    attr_accessor :email_address_text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address_text'] = 'emailAddressText'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address_text: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email_address_text = email_address_text unless email_address_text == 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.
+      email_address_text =
+        hash.key?('emailAddressText') ? hash['emailAddressText'] : 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.
+      ElectronicAddressEntity.new(email_address_text: email_address_text,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ElectronicAddressEntity | 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} email_address_text: #{@email_address_text}, 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} email_address_text: #{@email_address_text.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/employee_entity.rb

@@ -0,0 +1,176 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Represents an employee
+  class EmployeeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of the contact email addresses
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Array of the contact physical addresses
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # Array of the contact telephone numbers, with extension if any
+    # @return [Array[TelephoneNumberPlusExtension]]
+    attr_accessor :telephones
+
+    # The person's date of birth
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Country specific Tax Id associated with this customer. Masked as last
+    # four, e.g. xxx-xx-0123, or passed in encrypted payload. (SIN or NAS in
+    # Canada, SSN or TIN in US, etc.)
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Country originating the Customer's taxId element
+    # @return [Iso3166CountryCode2]
+    attr_accessor :tax_id_country
+
+    # A federal (such as passport) or state (such as driver's license) issued
+    # identifier
+    # @return [String]
+    attr_accessor :government_id
+
+    # Provider's long-term persistent id for the employee
+    # @return [String]
+    attr_accessor :employee_id
+
+    # Employee's full name
+    # @return [IndividualName2]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['tax_id_country'] = 'taxIdCountry'
+      @_hash['government_id'] = 'governmentId'
+      @_hash['employee_id'] = 'employeeId'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        addresses
+        telephones
+        date_of_birth
+        tax_id
+        tax_id_country
+        government_id
+        employee_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, emails: SKIP, addresses: SKIP, telephones: SKIP,
+                   date_of_birth: SKIP, tax_id: SKIP, tax_id_country: SKIP,
+                   government_id: SKIP, employee_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @tax_id_country = tax_id_country unless tax_id_country == SKIP
+      @government_id = government_id unless government_id == SKIP
+      @employee_id = employee_id unless employee_id == SKIP
+      @name = name
+      @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 = IndividualName2.from_hash(hash['name']) if hash['name']
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (TelephoneNumberPlusExtension.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      tax_id_country = hash.key?('taxIdCountry') ? hash['taxIdCountry'] : SKIP
+      government_id = hash.key?('governmentId') ? hash['governmentId'] : SKIP
+      employee_id = hash.key?('employeeId') ? hash['employeeId'] : 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.
+      EmployeeEntity.new(name: name,
+                         emails: emails,
+                         addresses: addresses,
+                         telephones: telephones,
+                         date_of_birth: date_of_birth,
+                         tax_id: tax_id,
+                         tax_id_country: tax_id_country,
+                         government_id: government_id,
+                         employee_id: employee_id,
+                         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} emails: #{@emails}, addresses: #{@addresses}, telephones: #{@telephones},"\
+      " date_of_birth: #{@date_of_birth}, tax_id: #{@tax_id}, tax_id_country: #{@tax_id_country},"\
+      " government_id: #{@government_id}, employee_id: #{@employee_id}, name: #{@name},"\
+      " 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} emails: #{@emails.inspect}, addresses: #{@addresses.inspect}, telephones:"\
+      " #{@telephones.inspect}, date_of_birth: #{@date_of_birth.inspect}, tax_id:"\
+      " #{@tax_id.inspect}, tax_id_country: #{@tax_id_country.inspect}, government_id:"\
+      " #{@government_id.inspect}, employee_id: #{@employee_id.inspect}, name: #{@name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end