factorial_api 3.0.1

data/lib/factorial_api/models/employee_updates_new_hire.rb

@@ -0,0 +1,569 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module F::Api
+  class EmployeeUpdatesNewHire < ApiModelBase
+    # The id of the new hire incidence
+    attr_accessor :id
+
+    # The status of the new hire incidence
+    attr_accessor :status
+
+    # The employee id of the new hire
+    attr_accessor :employee_id
+
+    # name of the employee.
+    attr_accessor :first_name
+
+    # last name of the employee.
+    attr_accessor :last_name
+
+    # The birth name of the new hire
+    attr_accessor :birth_name
+
+    # national identifier number.
+    attr_accessor :identifier
+
+    # type of identifier (ex passport).
+    attr_accessor :identifier_type
+
+    # payroll identifier.
+    attr_accessor :payroll_identifier
+
+    # personal email of the employee.
+    attr_accessor :work_email
+
+    # phone number of the employee.
+    attr_accessor :phone_number
+
+    # gender of the employee (male | female).
+    attr_accessor :gender
+
+    # job title of the employee.
+    attr_accessor :job_title
+
+    # address of the employee.
+    attr_accessor :address
+
+    # city of the employee.
+    attr_accessor :city
+
+    # country code of the employee (Spain ES, United Kingdom GB).
+    attr_accessor :country
+
+    # state/province/region of the employee.
+    attr_accessor :state
+
+    # postal code of the employee.
+    attr_accessor :postal_code
+
+    # birthday of the employee.
+    attr_accessor :date_of_birth
+
+    # nationality country code of the employee (Spain ES, United Kingdom GB).
+    attr_accessor :nationality
+
+    attr_accessor :start_date
+
+    attr_accessor :contract_effective_date
+
+    attr_accessor :contract_end_date
+
+    # bank account number of the employee.
+    attr_accessor :bank_account
+
+    # salary amount in cents.
+    attr_accessor :salary_amount_in_cents
+
+    attr_accessor :salary_frequency
+
+    attr_accessor :working_hours
+
+    attr_accessor :working_hours_frequency
+
+    # social security number of the employee.
+    attr_accessor :social_security_number
+
+    # manager id of the employee, you can get the manager id from employees endpoint.
+    attr_accessor :manager_id
+
+    attr_accessor :tax_id
+
+    # The legal entity id of the new hire
+    attr_accessor :legal_entity_id
+
+    # workplace id of the employee.
+    attr_accessor :workplace_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'status' => :'status',
+        :'employee_id' => :'employee_id',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'birth_name' => :'birth_name',
+        :'identifier' => :'identifier',
+        :'identifier_type' => :'identifier_type',
+        :'payroll_identifier' => :'payroll_identifier',
+        :'work_email' => :'work_email',
+        :'phone_number' => :'phone_number',
+        :'gender' => :'gender',
+        :'job_title' => :'job_title',
+        :'address' => :'address',
+        :'city' => :'city',
+        :'country' => :'country',
+        :'state' => :'state',
+        :'postal_code' => :'postal_code',
+        :'date_of_birth' => :'date_of_birth',
+        :'nationality' => :'nationality',
+        :'start_date' => :'start_date',
+        :'contract_effective_date' => :'contract_effective_date',
+        :'contract_end_date' => :'contract_end_date',
+        :'bank_account' => :'bank_account',
+        :'salary_amount_in_cents' => :'salary_amount_in_cents',
+        :'salary_frequency' => :'salary_frequency',
+        :'working_hours' => :'working_hours',
+        :'working_hours_frequency' => :'working_hours_frequency',
+        :'social_security_number' => :'social_security_number',
+        :'manager_id' => :'manager_id',
+        :'tax_id' => :'tax_id',
+        :'legal_entity_id' => :'legal_entity_id',
+        :'workplace_id' => :'workplace_id'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'status' => :'String',
+        :'employee_id' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'birth_name' => :'String',
+        :'identifier' => :'String',
+        :'identifier_type' => :'String',
+        :'payroll_identifier' => :'String',
+        :'work_email' => :'String',
+        :'phone_number' => :'String',
+        :'gender' => :'String',
+        :'job_title' => :'String',
+        :'address' => :'String',
+        :'city' => :'String',
+        :'country' => :'String',
+        :'state' => :'String',
+        :'postal_code' => :'String',
+        :'date_of_birth' => :'String',
+        :'nationality' => :'String',
+        :'start_date' => :'String',
+        :'contract_effective_date' => :'String',
+        :'contract_end_date' => :'String',
+        :'bank_account' => :'String',
+        :'salary_amount_in_cents' => :'Integer',
+        :'salary_frequency' => :'String',
+        :'working_hours' => :'Integer',
+        :'working_hours_frequency' => :'String',
+        :'social_security_number' => :'String',
+        :'manager_id' => :'String',
+        :'tax_id' => :'String',
+        :'legal_entity_id' => :'String',
+        :'workplace_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `F::Api::EmployeeUpdatesNewHire` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `F::Api::EmployeeUpdatesNewHire`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'employee_id')
+        self.employee_id = attributes[:'employee_id']
+      else
+        self.employee_id = nil
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      else
+        self.last_name = nil
+      end
+
+      if attributes.key?(:'birth_name')
+        self.birth_name = attributes[:'birth_name']
+      end
+
+      if attributes.key?(:'identifier')
+        self.identifier = attributes[:'identifier']
+      end
+
+      if attributes.key?(:'identifier_type')
+        self.identifier_type = attributes[:'identifier_type']
+      end
+
+      if attributes.key?(:'payroll_identifier')
+        self.payroll_identifier = attributes[:'payroll_identifier']
+      end
+
+      if attributes.key?(:'work_email')
+        self.work_email = attributes[:'work_email']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'job_title')
+        self.job_title = attributes[:'job_title']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      else
+        self.address = nil
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'contract_effective_date')
+        self.contract_effective_date = attributes[:'contract_effective_date']
+      end
+
+      if attributes.key?(:'contract_end_date')
+        self.contract_end_date = attributes[:'contract_end_date']
+      end
+
+      if attributes.key?(:'bank_account')
+        self.bank_account = attributes[:'bank_account']
+      end
+
+      if attributes.key?(:'salary_amount_in_cents')
+        self.salary_amount_in_cents = attributes[:'salary_amount_in_cents']
+      end
+
+      if attributes.key?(:'salary_frequency')
+        self.salary_frequency = attributes[:'salary_frequency']
+      end
+
+      if attributes.key?(:'working_hours')
+        self.working_hours = attributes[:'working_hours']
+      end
+
+      if attributes.key?(:'working_hours_frequency')
+        self.working_hours_frequency = attributes[:'working_hours_frequency']
+      end
+
+      if attributes.key?(:'social_security_number')
+        self.social_security_number = attributes[:'social_security_number']
+      end
+
+      if attributes.key?(:'manager_id')
+        self.manager_id = attributes[:'manager_id']
+      end
+
+      if attributes.key?(:'tax_id')
+        self.tax_id = attributes[:'tax_id']
+      end
+
+      if attributes.key?(:'legal_entity_id')
+        self.legal_entity_id = attributes[:'legal_entity_id']
+      end
+
+      if attributes.key?(:'workplace_id')
+        self.workplace_id = attributes[:'workplace_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @employee_id.nil?
+        invalid_properties.push('invalid value for "employee_id", employee_id cannot be nil.')
+      end
+
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @address.nil?
+        invalid_properties.push('invalid value for "address", address cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @status.nil?
+      return false if @employee_id.nil?
+      return false if @first_name.nil?
+      return false if @last_name.nil?
+      return false if @address.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        @id = nil
+        return
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        @status = nil
+        return
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] employee_id Value to be assigned
+    def employee_id=(employee_id)
+      if employee_id.nil?
+        @employee_id = nil
+        return
+      end
+
+      @employee_id = employee_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if first_name.nil?
+        @first_name = nil
+        return
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        @last_name = nil
+        return
+      end
+
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address Value to be assigned
+    def address=(address)
+      if address.nil?
+        @address = nil
+        return
+      end
+
+      @address = address
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          status == o.status &&
+          employee_id == o.employee_id &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          birth_name == o.birth_name &&
+          identifier == o.identifier &&
+          identifier_type == o.identifier_type &&
+          payroll_identifier == o.payroll_identifier &&
+          work_email == o.work_email &&
+          phone_number == o.phone_number &&
+          gender == o.gender &&
+          job_title == o.job_title &&
+          address == o.address &&
+          city == o.city &&
+          country == o.country &&
+          state == o.state &&
+          postal_code == o.postal_code &&
+          date_of_birth == o.date_of_birth &&
+          nationality == o.nationality &&
+          start_date == o.start_date &&
+          contract_effective_date == o.contract_effective_date &&
+          contract_end_date == o.contract_end_date &&
+          bank_account == o.bank_account &&
+          salary_amount_in_cents == o.salary_amount_in_cents &&
+          salary_frequency == o.salary_frequency &&
+          working_hours == o.working_hours &&
+          working_hours_frequency == o.working_hours_frequency &&
+          social_security_number == o.social_security_number &&
+          manager_id == o.manager_id &&
+          tax_id == o.tax_id &&
+          legal_entity_id == o.legal_entity_id &&
+          workplace_id == o.workplace_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, status, employee_id, first_name, last_name, birth_name, identifier, identifier_type, payroll_identifier, work_email, phone_number, gender, job_title, address, city, country, state, postal_code, date_of_birth, nationality, start_date, contract_effective_date, contract_end_date, bank_account, salary_amount_in_cents, salary_frequency, working_hours, working_hours_frequency, social_security_number, manager_id, tax_id, legal_entity_id, workplace_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end