merge_hris_client 1.0.2 → 1.0.3

data/lib/merge_hris_client/models/bank_info.rb

@@ -0,0 +1,323 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeHRISClient
+  # # The BankInfo Object ### Description The `BankInfo` object is used to represent the Bank Account information for an Employee. This is often referenced with an Employee object.  ### Usage Example Fetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank information.
+  class BankInfo
+    attr_accessor :id
+
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
+    # The employee with this bank account.
+    attr_accessor :employee
+
+    # The account number.
+    attr_accessor :account_number
+
+    # The routing number.
+    attr_accessor :routing_number
+
+    # The bank name.
+    attr_accessor :bank_name
+
+    # The bank account type
+    attr_accessor :account_type
+
+    # When the matching bank object was created in the third party system.
+    attr_accessor :remote_created_at
+
+    attr_accessor :remote_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'remote_id' => :'remote_id',
+        :'employee' => :'employee',
+        :'account_number' => :'account_number',
+        :'routing_number' => :'routing_number',
+        :'bank_name' => :'bank_name',
+        :'account_type' => :'account_type',
+        :'remote_created_at' => :'remote_created_at',
+        :'remote_data' => :'remote_data'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'remote_id' => :'String',
+        :'employee' => :'String',
+        :'account_number' => :'String',
+        :'routing_number' => :'String',
+        :'bank_name' => :'String',
+        :'account_type' => :'AccountTypeEnum',
+        :'remote_created_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remote_id',
+        :'employee',
+        :'account_number',
+        :'routing_number',
+        :'bank_name',
+        :'account_type',
+        :'remote_created_at',
+        :'remote_data'
+      ])
+    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 `MergeHRISClient::BankInfo` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MergeHRISClient::BankInfo`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'remote_id')
+        self.remote_id = attributes[:'remote_id']
+      end
+
+      if attributes.key?(:'employee')
+        self.employee = attributes[:'employee']
+      end
+
+      if attributes.key?(:'account_number')
+        self.account_number = attributes[:'account_number']
+      end
+
+      if attributes.key?(:'routing_number')
+        self.routing_number = attributes[:'routing_number']
+      end
+
+      if attributes.key?(:'bank_name')
+        self.bank_name = attributes[:'bank_name']
+      end
+
+      if attributes.key?(:'account_type')
+        self.account_type = attributes[:'account_type']
+      end
+
+      if attributes.key?(:'remote_created_at')
+        self.remote_created_at = attributes[:'remote_created_at']
+      end
+
+      if attributes.key?(:'remote_data')
+        if (value = attributes[:'remote_data']).is_a?(Array)
+          self.remote_data = value
+        end
+      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
+      invalid_properties = Array.new
+      if !@account_number.nil? && @account_number.to_s.length > 100
+        invalid_properties.push('invalid value for "account_number", the character length must be smaller than or equal to 100.')
+      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?
+      return false if !@account_number.nil? && @account_number.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_number Value to be assigned
+    def account_number=(account_number)
+      if !account_number.nil? && account_number.to_s.length > 100
+        fail ArgumentError, 'invalid value for "account_number", the character length must be smaller than or equal to 100.'
+      end
+
+      @account_number = account_number
+    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 &&
+          remote_id == o.remote_id &&
+          employee == o.employee &&
+          account_number == o.account_number &&
+          routing_number == o.routing_number &&
+          bank_name == o.bank_name &&
+          account_type == o.account_type &&
+          remote_created_at == o.remote_created_at &&
+          remote_data == o.remote_data
+    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, remote_id, employee, account_number, routing_number, bank_name, account_type, remote_created_at, remote_data].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = MergeHRISClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/merge_hris_client/models/categories_enum.rb

@@ -0,0 +1,36 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeHRISClient
+  class CategoriesEnum
+    HRIS = "hris".freeze
+    ATS = "ats".freeze
+    ACCOUNTING = "accounting".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      value
+    end
+  end
+end

data/lib/merge_hris_client/models/category_enum.rb

@@ -0,0 +1,36 @@
+=begin
+#Merge HRIS API
+
+#The unified API for building rich integrations with multiple HR Information System platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeHRISClient
+  class CategoryEnum
+    HRIS = "hris".freeze
+    ATS = "ats".freeze
+    ACCOUNTING = "accounting".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      value
+    end
+  end
+end

data/lib/merge_hris_client/models/data_passthrough_request.rb

@@ -26,6 +26,8 @@ module MergeHRISClient
 
     attr_accessor :headers
 
+    attr_accessor :request_format
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -33,7 +35,8 @@ module MergeHRISClient
         :'path' => :'path',
         :'base_url_override' => :'base_url_override',
         :'data' => :'data',
-        :'headers' => :'headers'
+        :'headers' => :'headers',
+        :'request_format' => :'request_format'
       }
     end
 
@@ -48,8 +51,9 @@ module MergeHRISClient
         :'method' => :'MethodEnum',
         :'path' => :'String',
         :'base_url_override' => :'String',
-        :'data' => :'Hash<String, Object>',
-        :'headers' => :'Hash<String, Object>'
+        :'data' => :'String',
+        :'headers' => :'Hash<String, Object>',
+        :'request_format' => :'RequestFormatEnum'
       }
     end
 
@@ -58,7 +62,8 @@ module MergeHRISClient
       Set.new([
         :'base_url_override',
         :'data',
-        :'headers'
+        :'headers',
+        :'request_format'
       ])
     end
 
@@ -90,9 +95,7 @@ module MergeHRISClient
       end
 
       if attributes.key?(:'data')
-        if (value = attributes[:'data']).is_a?(Hash)
-          self.data = value
-        end
+        self.data = attributes[:'data']
       end
 
       if attributes.key?(:'headers')
@@ -100,6 +103,10 @@ module MergeHRISClient
           self.headers = value
         end
       end
+
+      if attributes.key?(:'request_format')
+        self.request_format = attributes[:'request_format']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -114,6 +121,18 @@ module MergeHRISClient
         invalid_properties.push('invalid value for "path", path cannot be nil.')
       end
 
+      if @path.to_s.length < 1
+        invalid_properties.push('invalid value for "path", the character length must be great than or equal to 1.')
+      end
+
+      if !@base_url_override.nil? && @base_url_override.to_s.length < 1
+        invalid_properties.push('invalid value for "base_url_override", the character length must be great than or equal to 1.')
+      end
+
+      if !@data.nil? && @data.to_s.length < 1
+        invalid_properties.push('invalid value for "data", the character length must be great than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -122,9 +141,46 @@ module MergeHRISClient
     def valid?
       return false if @method.nil?
       return false if @path.nil?
+      return false if @path.to_s.length < 1
+      return false if !@base_url_override.nil? && @base_url_override.to_s.length < 1
+      return false if !@data.nil? && @data.to_s.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] path Value to be assigned
+    def path=(path)
+      if path.nil?
+        fail ArgumentError, 'path cannot be nil'
+      end
+
+      if path.to_s.length < 1
+        fail ArgumentError, 'invalid value for "path", the character length must be great than or equal to 1.'
+      end
+
+      @path = path
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] base_url_override Value to be assigned
+    def base_url_override=(base_url_override)
+      if !base_url_override.nil? && base_url_override.to_s.length < 1
+        fail ArgumentError, 'invalid value for "base_url_override", the character length must be great than or equal to 1.'
+      end
+
+      @base_url_override = base_url_override
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if !data.nil? && data.to_s.length < 1
+        fail ArgumentError, 'invalid value for "data", the character length must be great than or equal to 1.'
+      end
+
+      @data = data
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -134,7 +190,8 @@ module MergeHRISClient
           path == o.path &&
           base_url_override == o.base_url_override &&
           data == o.data &&
-          headers == o.headers
+          headers == o.headers &&
+          request_format == o.request_format
     end
 
     # @see the `==` method
@@ -146,7 +203,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [method, path, base_url_override, data, headers].hash
+      [method, path, base_url_override, data, headers, request_format].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/employee.rb

@@ -33,7 +33,7 @@ module MergeHRISClient
     # The employee's last name.
     attr_accessor :last_name
 
-    # The employee's full name, to use for display purposes.
+    # The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.
     attr_accessor :display_full_name
 
     # The employee's work email.
@@ -60,6 +60,9 @@ module MergeHRISClient
     # The employee's team.
     attr_accessor :team
 
+    # The employee's pay group
+    attr_accessor :pay_group
+
     # The employee's social security number.
     attr_accessor :ssn
 
@@ -75,10 +78,10 @@ module MergeHRISClient
     # The employee's date of birth.
     attr_accessor :date_of_birth
 
-    # The employee's hire date. If an employee has multiple hire dates from previous employments, this represents the most recent hire date.
+    # The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.
     attr_accessor :hire_date
 
-    # The employee's start date.
+    # The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date.
     attr_accessor :start_date
 
     # The employment status of the employee.
@@ -92,6 +95,9 @@ module MergeHRISClient
 
     attr_accessor :remote_data
 
+    # Custom fields configured for a given model.
+    attr_accessor :custom_fields
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -110,6 +116,7 @@ module MergeHRISClient
         :'work_location' => :'work_location',
         :'manager' => :'manager',
         :'team' => :'team',
+        :'pay_group' => :'pay_group',
         :'ssn' => :'ssn',
         :'gender' => :'gender',
         :'ethnicity' => :'ethnicity',
@@ -120,7 +127,8 @@ module MergeHRISClient
         :'employment_status' => :'employment_status',
         :'termination_date' => :'termination_date',
         :'avatar' => :'avatar',
-        :'remote_data' => :'remote_data'
+        :'remote_data' => :'remote_data',
+        :'custom_fields' => :'custom_fields'
       }
     end
 
@@ -147,6 +155,7 @@ module MergeHRISClient
         :'work_location' => :'String',
         :'manager' => :'String',
         :'team' => :'String',
+        :'pay_group' => :'String',
         :'ssn' => :'String',
         :'gender' => :'GenderEnum',
         :'ethnicity' => :'EthnicityEnum',
@@ -157,7 +166,8 @@ module MergeHRISClient
         :'employment_status' => :'EmploymentStatusEnum',
         :'termination_date' => :'Time',
         :'avatar' => :'String',
-        :'remote_data' => :'Array<RemoteData>'
+        :'remote_data' => :'Array<RemoteData>',
+        :'custom_fields' => :'Hash<String, Object>'
       }
     end
 
@@ -177,6 +187,7 @@ module MergeHRISClient
         :'work_location',
         :'manager',
         :'team',
+        :'pay_group',
         :'ssn',
         :'gender',
         :'ethnicity',
@@ -187,7 +198,8 @@ module MergeHRISClient
         :'employment_status',
         :'termination_date',
         :'avatar',
-        :'remote_data'
+        :'remote_data',
+        :'custom_fields'
       ])
     end
 
@@ -268,6 +280,10 @@ module MergeHRISClient
         self.team = attributes[:'team']
       end
 
+      if attributes.key?(:'pay_group')
+        self.pay_group = attributes[:'pay_group']
+      end
+
       if attributes.key?(:'ssn')
         self.ssn = attributes[:'ssn']
       end
@@ -313,6 +329,12 @@ module MergeHRISClient
           self.remote_data = value
         end
       end
+
+      if attributes.key?(:'custom_fields')
+        if (value = attributes[:'custom_fields']).is_a?(Hash)
+          self.custom_fields = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -408,6 +430,7 @@ module MergeHRISClient
           work_location == o.work_location &&
           manager == o.manager &&
           team == o.team &&
+          pay_group == o.pay_group &&
           ssn == o.ssn &&
           gender == o.gender &&
           ethnicity == o.ethnicity &&
@@ -418,7 +441,8 @@ module MergeHRISClient
           employment_status == o.employment_status &&
           termination_date == o.termination_date &&
           avatar == o.avatar &&
-          remote_data == o.remote_data
+          remote_data == o.remote_data &&
+          custom_fields == o.custom_fields
     end
 
     # @see the `==` method
@@ -430,7 +454,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee_number, company, first_name, last_name, display_full_name, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, employment_status, termination_date, avatar, remote_data].hash
+      [id, remote_id, employee_number, company, first_name, last_name, display_full_name, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, employment_status, termination_date, avatar, remote_data, custom_fields].hash
     end
 
     # Builds the object from hash