fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/employee_entity1.rb

@@ -0,0 +1,175 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The employee
+  class EmployeeEntity1 < 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
+    # @return [Array[TelephoneNumber]]
+    attr_accessor :telephones
+
+    # The person's date of birth
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Country specific Tax Id associated with this customer (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 [Iso3166CountryCode]
+    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 [IndividualName]
+    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 = IndividualName.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 << (TelephoneNumber.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.
+      EmployeeEntity1.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

data/lib/fdx_api/models/employer_entity.rb

@@ -0,0 +1,125 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Represents an employer
+  class EmployerEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Provider's long-term persistent id for the employer
+    # @return [String]
+    attr_accessor :employer_id
+
+    # The employer's name
+    # @return [BusinessName]
+    attr_accessor :name
+
+    # Array of Doing Business As names for this employer
+    # @return [Array[String]]
+    attr_accessor :dbas
+
+    # Country specific Tax Id associated with this employer (FEIN in USA or BN
+    # in Canada)
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Country originating the employer's taxId element
+    # @return [Iso3166CountryCode]
+    attr_accessor :tax_id_country
+
+    # Employer's various contact information
+    # @return [ContactsEntity]
+    attr_accessor :contacts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employer_id'] = 'employerId'
+      @_hash['name'] = 'name'
+      @_hash['dbas'] = 'dbas'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['tax_id_country'] = 'taxIdCountry'
+      @_hash['contacts'] = 'contacts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        employer_id
+        dbas
+        tax_id
+        tax_id_country
+        contacts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, employer_id: SKIP, dbas: SKIP, tax_id: SKIP,
+                   tax_id_country: SKIP, contacts: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employer_id = employer_id unless employer_id == SKIP
+      @name = name
+      @dbas = dbas unless dbas == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @tax_id_country = tax_id_country unless tax_id_country == SKIP
+      @contacts = contacts unless contacts == 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 = BusinessName.from_hash(hash['name']) if hash['name']
+      employer_id = hash.key?('employerId') ? hash['employerId'] : SKIP
+      dbas = hash.key?('dbas') ? hash['dbas'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      tax_id_country = hash.key?('taxIdCountry') ? hash['taxIdCountry'] : SKIP
+      contacts = ContactsEntity.from_hash(hash['contacts']) if hash['contacts']
+
+      # 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.
+      EmployerEntity.new(name: name,
+                         employer_id: employer_id,
+                         dbas: dbas,
+                         tax_id: tax_id,
+                         tax_id_country: tax_id_country,
+                         contacts: contacts,
+                         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} employer_id: #{@employer_id}, name: #{@name}, dbas: #{@dbas}, tax_id:"\
+      " #{@tax_id}, tax_id_country: #{@tax_id_country}, contacts: #{@contacts},"\
+      " 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} employer_id: #{@employer_id.inspect}, name: #{@name.inspect}, dbas:"\
+      " #{@dbas.inspect}, tax_id: #{@tax_id.inspect}, tax_id_country: #{@tax_id_country.inspect},"\
+      " contacts: #{@contacts.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/employer_entity1.rb

@@ -0,0 +1,125 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The employer for the job/position
+  class EmployerEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Provider's long-term persistent id for the employer
+    # @return [String]
+    attr_accessor :employer_id
+
+    # The employer's name
+    # @return [BusinessName]
+    attr_accessor :name
+
+    # Array of Doing Business As names for this employer
+    # @return [Array[String]]
+    attr_accessor :dbas
+
+    # Country specific Tax Id associated with this employer (FEIN in USA or BN
+    # in Canada)
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Country originating the employer's taxId element
+    # @return [Iso3166CountryCode]
+    attr_accessor :tax_id_country
+
+    # Employer's various contact information
+    # @return [ContactsEntity]
+    attr_accessor :contacts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employer_id'] = 'employerId'
+      @_hash['name'] = 'name'
+      @_hash['dbas'] = 'dbas'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['tax_id_country'] = 'taxIdCountry'
+      @_hash['contacts'] = 'contacts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        employer_id
+        dbas
+        tax_id
+        tax_id_country
+        contacts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, employer_id: SKIP, dbas: SKIP, tax_id: SKIP,
+                   tax_id_country: SKIP, contacts: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employer_id = employer_id unless employer_id == SKIP
+      @name = name
+      @dbas = dbas unless dbas == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @tax_id_country = tax_id_country unless tax_id_country == SKIP
+      @contacts = contacts unless contacts == 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 = BusinessName.from_hash(hash['name']) if hash['name']
+      employer_id = hash.key?('employerId') ? hash['employerId'] : SKIP
+      dbas = hash.key?('dbas') ? hash['dbas'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      tax_id_country = hash.key?('taxIdCountry') ? hash['taxIdCountry'] : SKIP
+      contacts = ContactsEntity.from_hash(hash['contacts']) if hash['contacts']
+
+      # 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.
+      EmployerEntity1.new(name: name,
+                          employer_id: employer_id,
+                          dbas: dbas,
+                          tax_id: tax_id,
+                          tax_id_country: tax_id_country,
+                          contacts: contacts,
+                          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} employer_id: #{@employer_id}, name: #{@name}, dbas: #{@dbas}, tax_id:"\
+      " #{@tax_id}, tax_id_country: #{@tax_id_country}, contacts: #{@contacts},"\
+      " 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} employer_id: #{@employer_id.inspect}, name: #{@name.inspect}, dbas:"\
+      " #{@dbas.inspect}, tax_id: #{@tax_id.inspect}, tax_id_country: #{@tax_id_country.inspect},"\
+      " contacts: #{@contacts.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/employment.rb

@@ -0,0 +1,149 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Provides a person's employment details
+  class Employment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The employer for the job/position
+    # @return [EmployerEntity1]
+    attr_accessor :employer
+
+    # The title of the job/position
+    # @return [String]
+    attr_accessor :job_title
+
+    # The date when employee joined for the first time.
+    # @return [Date]
+    attr_accessor :original_hire_date
+
+    # The date when employee re-joined most recently.
+    # @return [Date]
+    attr_accessor :most_recent_hire_date
+
+    # The employment end date
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The employee's employment status, ACTIVE or INACTIVE
+    # @return [ActiveInactiveStatus2]
+    attr_accessor :status
+
+    # Supplemental detail of employee's employment status
+    # @return [SupplementalStatus2]
+    attr_accessor :supplemental_status
+
+    # The employee's employment type, CONTRACTED, FULL-TIME, OTHER, PART-TIME,
+    # SEASONAL, TEMPORARY
+    # @return [EmploymentType2]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employer'] = 'employer'
+      @_hash['job_title'] = 'jobTitle'
+      @_hash['original_hire_date'] = 'originalHireDate'
+      @_hash['most_recent_hire_date'] = 'mostRecentHireDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['status'] = 'status'
+      @_hash['supplemental_status'] = 'supplementalStatus'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        job_title
+        original_hire_date
+        most_recent_hire_date
+        end_date
+        supplemental_status
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(employer:, status:, job_title: SKIP,
+                   original_hire_date: SKIP, most_recent_hire_date: SKIP,
+                   end_date: SKIP, supplemental_status: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employer = employer
+      @job_title = job_title unless job_title == SKIP
+      @original_hire_date = original_hire_date unless original_hire_date == SKIP
+      @most_recent_hire_date = most_recent_hire_date unless most_recent_hire_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @status = status
+      @supplemental_status = supplemental_status unless supplemental_status == 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.
+      employer = EmployerEntity1.from_hash(hash['employer']) if hash['employer']
+      status = hash.key?('status') ? hash['status'] : nil
+      job_title = hash.key?('jobTitle') ? hash['jobTitle'] : SKIP
+      original_hire_date =
+        hash.key?('originalHireDate') ? hash['originalHireDate'] : SKIP
+      most_recent_hire_date =
+        hash.key?('mostRecentHireDate') ? hash['mostRecentHireDate'] : SKIP
+      end_date = hash.key?('endDate') ? hash['endDate'] : SKIP
+      supplemental_status =
+        hash.key?('supplementalStatus') ? hash['supplementalStatus'] : 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.
+      Employment.new(employer: employer,
+                     status: status,
+                     job_title: job_title,
+                     original_hire_date: original_hire_date,
+                     most_recent_hire_date: most_recent_hire_date,
+                     end_date: end_date,
+                     supplemental_status: supplemental_status,
+                     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} employer: #{@employer}, job_title: #{@job_title}, original_hire_date:"\
+      " #{@original_hire_date}, most_recent_hire_date: #{@most_recent_hire_date}, end_date:"\
+      " #{@end_date}, status: #{@status}, supplemental_status: #{@supplemental_status}, 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} employer: #{@employer.inspect}, job_title: #{@job_title.inspect},"\
+      " original_hire_date: #{@original_hire_date.inspect}, most_recent_hire_date:"\
+      " #{@most_recent_hire_date.inspect}, end_date: #{@end_date.inspect}, status:"\
+      " #{@status.inspect}, supplemental_status: #{@supplemental_status.inspect}, type:"\
+      " #{@type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end