merge_hris_client 3.1.0 → 3.2.1

data/lib/merge_hris_client/models/earning.rb

@@ -32,11 +32,11 @@ module MergeHRISClient
     # Indicates whether or not this object has been deleted by third party webhooks.
     attr_accessor :remote_was_deleted
 
-    attr_accessor :field_mappings
-
     # This is the datetime that this object was last updated by Merge
     attr_accessor :modified_at
 
+    attr_accessor :field_mappings
+
     attr_accessor :remote_data
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -48,8 +48,8 @@ module MergeHRISClient
         :'amount' => :'amount',
         :'type' => :'type',
         :'remote_was_deleted' => :'remote_was_deleted',
-        :'field_mappings' => :'field_mappings',
         :'modified_at' => :'modified_at',
+        :'field_mappings' => :'field_mappings',
         :'remote_data' => :'remote_data'
       }
     end
@@ -68,8 +68,8 @@ module MergeHRISClient
         :'amount' => :'Float',
         :'type' => :'EarningTypeEnum',
         :'remote_was_deleted' => :'Boolean',
-        :'field_mappings' => :'Hash<String, Object>',
         :'modified_at' => :'Time',
+        :'field_mappings' => :'Hash<String, Object>',
         :'remote_data' => :'Array<RemoteData>'
       }
     end
@@ -125,16 +125,16 @@ module MergeHRISClient
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
 
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
       if attributes.key?(:'field_mappings')
         if (value = attributes[:'field_mappings']).is_a?(Hash)
           self.field_mappings = value
         end
       end
 
-      if attributes.key?(:'modified_at')
-        self.modified_at = attributes[:'modified_at']
-      end
-
       if attributes.key?(:'remote_data')
         if (value = attributes[:'remote_data']).is_a?(Array)
           self.remote_data = value
@@ -166,8 +166,8 @@ module MergeHRISClient
           amount == o.amount &&
           type == o.type &&
           remote_was_deleted == o.remote_was_deleted &&
-          field_mappings == o.field_mappings &&
           modified_at == o.modified_at &&
+          field_mappings == o.field_mappings &&
           remote_data == o.remote_data
     end
 
@@ -180,7 +180,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee_payroll_run, amount, type, remote_was_deleted, field_mappings, modified_at, remote_data].hash
+      [id, remote_id, employee_payroll_run, amount, type, remote_was_deleted, modified_at, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/employee.rb

@@ -106,11 +106,11 @@ module MergeHRISClient
 
     attr_accessor :remote_was_deleted
 
-    attr_accessor :field_mappings
-
     # This is the datetime that this object was last updated by Merge
     attr_accessor :modified_at
 
+    attr_accessor :field_mappings
+
     attr_accessor :remote_data
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -147,8 +147,8 @@ module MergeHRISClient
         :'avatar' => :'avatar',
         :'custom_fields' => :'custom_fields',
         :'remote_was_deleted' => :'remote_was_deleted',
-        :'field_mappings' => :'field_mappings',
         :'modified_at' => :'modified_at',
+        :'field_mappings' => :'field_mappings',
         :'remote_data' => :'remote_data'
       }
     end
@@ -192,8 +192,8 @@ module MergeHRISClient
         :'avatar' => :'String',
         :'custom_fields' => :'Hash<String, Object>',
         :'remote_was_deleted' => :'Boolean',
-        :'field_mappings' => :'Hash<String, Object>',
         :'modified_at' => :'Time',
+        :'field_mappings' => :'Hash<String, Object>',
         :'remote_data' => :'Array<RemoteData>'
       }
     end
@@ -378,16 +378,16 @@ module MergeHRISClient
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
 
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
       if attributes.key?(:'field_mappings')
         if (value = attributes[:'field_mappings']).is_a?(Hash)
           self.field_mappings = value
         end
       end
 
-      if attributes.key?(:'modified_at')
-        self.modified_at = attributes[:'modified_at']
-      end
-
       if attributes.key?(:'remote_data')
         if (value = attributes[:'remote_data']).is_a?(Array)
           self.remote_data = value
@@ -504,8 +504,8 @@ module MergeHRISClient
           avatar == o.avatar &&
           custom_fields == o.custom_fields &&
           remote_was_deleted == o.remote_was_deleted &&
-          field_mappings == o.field_mappings &&
           modified_at == o.modified_at &&
+          field_mappings == o.field_mappings &&
           remote_data == o.remote_data
     end
 
@@ -518,7 +518,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, username, groups, 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, remote_created_at, employment_status, termination_date, avatar, custom_fields, remote_was_deleted, field_mappings, modified_at, remote_data].hash
+      [id, remote_id, employee_number, company, first_name, last_name, display_full_name, username, groups, 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, remote_created_at, employment_status, termination_date, avatar, custom_fields, remote_was_deleted, modified_at, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/employee_payroll_run.rb

@@ -51,11 +51,11 @@ module MergeHRISClient
     # Indicates whether or not this object has been deleted by third party webhooks.
     attr_accessor :remote_was_deleted
 
-    attr_accessor :field_mappings
-
     # This is the datetime that this object was last updated by Merge
     attr_accessor :modified_at
 
+    attr_accessor :field_mappings
+
     attr_accessor :remote_data
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -74,8 +74,8 @@ module MergeHRISClient
         :'deductions' => :'deductions',
         :'taxes' => :'taxes',
         :'remote_was_deleted' => :'remote_was_deleted',
-        :'field_mappings' => :'field_mappings',
         :'modified_at' => :'modified_at',
+        :'field_mappings' => :'field_mappings',
         :'remote_data' => :'remote_data'
       }
     end
@@ -101,8 +101,8 @@ module MergeHRISClient
         :'deductions' => :'Array<Deduction>',
         :'taxes' => :'Array<Tax>',
         :'remote_was_deleted' => :'Boolean',
-        :'field_mappings' => :'Hash<String, Object>',
         :'modified_at' => :'Time',
+        :'field_mappings' => :'Hash<String, Object>',
         :'remote_data' => :'Array<RemoteData>'
       }
     end
@@ -196,16 +196,16 @@ module MergeHRISClient
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
 
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
       if attributes.key?(:'field_mappings')
         if (value = attributes[:'field_mappings']).is_a?(Hash)
           self.field_mappings = value
         end
       end
 
-      if attributes.key?(:'modified_at')
-        self.modified_at = attributes[:'modified_at']
-      end
-
       if attributes.key?(:'remote_data')
         if (value = attributes[:'remote_data']).is_a?(Array)
           self.remote_data = value
@@ -244,8 +244,8 @@ module MergeHRISClient
           deductions == o.deductions &&
           taxes == o.taxes &&
           remote_was_deleted == o.remote_was_deleted &&
-          field_mappings == o.field_mappings &&
           modified_at == o.modified_at &&
+          field_mappings == o.field_mappings &&
           remote_data == o.remote_data
     end
 
@@ -258,7 +258,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee, payroll_run, gross_pay, net_pay, start_date, end_date, check_date, earnings, deductions, taxes, remote_was_deleted, field_mappings, modified_at, remote_data].hash
+      [id, remote_id, employee, payroll_run, gross_pay, net_pay, start_date, end_date, check_date, earnings, deductions, taxes, remote_was_deleted, modified_at, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/employer_benefit.rb

@@ -0,0 +1,363 @@
+=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 EmployerBenefit Object ### Description The `Employer Benefit` object is used to represent a benefit plan offered by a company.  ### Usage Example Fetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all EmployerBenefits.
+  class EmployerBenefit
+    attr_accessor :id
+
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
+    # The type of benefit plan.  * `MEDICAL` - MEDICAL * `HEALTH_SAVINGS` - HEALTH_SAVINGS * `INSURANCE` - INSURANCE * `RETIREMENT` - RETIREMENT * `OTHER` - OTHER
+    attr_accessor :benefit_plan_type
+
+    # The employer benefit's name - typically the carrier or network name.
+    attr_accessor :name
+
+    # The employer benefit's description.
+    attr_accessor :description
+
+    # The employer benefit's deduction code.
+    attr_accessor :deduction_code
+
+    # Indicates whether or not this object has been deleted by third party webhooks.
+    attr_accessor :remote_was_deleted
+
+    # This is the datetime that this object was last updated by Merge
+    attr_accessor :modified_at
+
+    attr_accessor :field_mappings
+
+    attr_accessor :remote_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'remote_id' => :'remote_id',
+        :'benefit_plan_type' => :'benefit_plan_type',
+        :'name' => :'name',
+        :'description' => :'description',
+        :'deduction_code' => :'deduction_code',
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'modified_at' => :'modified_at',
+        :'field_mappings' => :'field_mappings',
+        :'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',
+        :'benefit_plan_type' => :'BenefitPlanTypeEnum',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'deduction_code' => :'String',
+        :'remote_was_deleted' => :'Boolean',
+        :'modified_at' => :'Time',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'remote_data' => :'Array<Hash<String, Object>>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remote_id',
+        :'benefit_plan_type',
+        :'name',
+        :'description',
+        :'deduction_code',
+        :'field_mappings',
+        :'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::EmployerBenefit` 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::EmployerBenefit`. 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?(:'benefit_plan_type')
+        self.benefit_plan_type = attributes[:'benefit_plan_type']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'deduction_code')
+        self.deduction_code = attributes[:'deduction_code']
+      end
+
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
+      if attributes.key?(:'field_mappings')
+        if (value = attributes[:'field_mappings']).is_a?(Hash)
+          self.field_mappings = value
+        end
+      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 !@name.nil? && @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 2000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@deduction_code.nil? && @deduction_code.to_s.length > 60
+        invalid_properties.push('invalid value for "deduction_code", the character length must be smaller than or equal to 60.')
+      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 !@name.nil? && @name.to_s.length > 200
+      return false if !@description.nil? && @description.to_s.length > 2000
+      return false if !@deduction_code.nil? && @deduction_code.to_s.length > 60
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] deduction_code Value to be assigned
+    def deduction_code=(deduction_code)
+      if !deduction_code.nil? && deduction_code.to_s.length > 60
+        fail ArgumentError, 'invalid value for "deduction_code", the character length must be smaller than or equal to 60.'
+      end
+
+      @deduction_code = deduction_code
+    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 &&
+          benefit_plan_type == o.benefit_plan_type &&
+          name == o.name &&
+          description == o.description &&
+          deduction_code == o.deduction_code &&
+          remote_was_deleted == o.remote_was_deleted &&
+          modified_at == o.modified_at &&
+          field_mappings == o.field_mappings &&
+          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, benefit_plan_type, name, description, deduction_code, remote_was_deleted, modified_at, field_mappings, 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
+      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/employment.rb

@@ -54,11 +54,11 @@ module MergeHRISClient
     # Indicates whether or not this object has been deleted by third party webhooks.
     attr_accessor :remote_was_deleted
 
-    attr_accessor :field_mappings
-
     # This is the datetime that this object was last updated by Merge
     attr_accessor :modified_at
 
+    attr_accessor :field_mappings
+
     attr_accessor :remote_data
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -77,8 +77,8 @@ module MergeHRISClient
         :'effective_date' => :'effective_date',
         :'employment_type' => :'employment_type',
         :'remote_was_deleted' => :'remote_was_deleted',
-        :'field_mappings' => :'field_mappings',
         :'modified_at' => :'modified_at',
+        :'field_mappings' => :'field_mappings',
         :'remote_data' => :'remote_data'
       }
     end
@@ -104,8 +104,8 @@ module MergeHRISClient
         :'effective_date' => :'Time',
         :'employment_type' => :'EmploymentTypeEnum',
         :'remote_was_deleted' => :'Boolean',
-        :'field_mappings' => :'Hash<String, Object>',
         :'modified_at' => :'Time',
+        :'field_mappings' => :'Hash<String, Object>',
         :'remote_data' => :'Array<RemoteData>'
       }
     end
@@ -196,16 +196,16 @@ module MergeHRISClient
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
 
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
       if attributes.key?(:'field_mappings')
         if (value = attributes[:'field_mappings']).is_a?(Hash)
           self.field_mappings = value
         end
       end
 
-      if attributes.key?(:'modified_at')
-        self.modified_at = attributes[:'modified_at']
-      end
-
       if attributes.key?(:'remote_data')
         if (value = attributes[:'remote_data']).is_a?(Array)
           self.remote_data = value
@@ -244,8 +244,8 @@ module MergeHRISClient
           effective_date == o.effective_date &&
           employment_type == o.employment_type &&
           remote_was_deleted == o.remote_was_deleted &&
-          field_mappings == o.field_mappings &&
           modified_at == o.modified_at &&
+          field_mappings == o.field_mappings &&
           remote_data == o.remote_data
     end
 
@@ -258,7 +258,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee, job_title, pay_rate, pay_period, pay_frequency, pay_currency, pay_group, flsa_status, effective_date, employment_type, remote_was_deleted, field_mappings, modified_at, remote_data].hash
+      [id, remote_id, employee, job_title, pay_rate, pay_period, pay_frequency, pay_currency, pay_group, flsa_status, effective_date, employment_type, remote_was_deleted, modified_at, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/end_user_details_request.rb

@@ -33,7 +33,7 @@ module MergeHRISClient
     # An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
     attr_accessor :link_expiry_mins
 
-    # Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/.
+    # Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
     attr_accessor :should_create_magic_link_url
 
     # An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.