merge_hris_client 2.0.0 → 2.0.1

data/lib/merge_hris_client/models/company.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Company Object ### Description The `Company` object is used to represent a Company.  ### Usage Example Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companies.
+  # # The Company Object ### Description The `Company` object is used to represent a Company within the HRIS / Payroll system.  ### Usage Example Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companies.
   class Company
     attr_accessor :id
 

data/lib/merge_hris_client/models/data_passthrough_request.rb

@@ -27,6 +27,7 @@ module MergeHRISClient
     # Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`.
     attr_accessor :multipart_form_data
 
+    # The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server.
     attr_accessor :headers
 
     attr_accessor :request_format

data/lib/merge_hris_client/models/earning.rb

@@ -61,6 +61,7 @@ module MergeHRISClient
         :'employee_payroll_run',
         :'amount',
         :'type',
+        :'remote_data'
       ])
     end
 

data/lib/merge_hris_client/models/employee.rb

@@ -21,7 +21,7 @@ module MergeHRISClient
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
-    # The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user.
+    # The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.
     attr_accessor :employee_number
 
     attr_accessor :company

data/lib/merge_hris_client/models/employee_request.rb

@@ -19,7 +19,7 @@ module MergeHRISClient
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
-    # The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user.
+    # The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.
     attr_accessor :employee_number
 
     attr_accessor :company

data/lib/merge_hris_client/models/employment.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Employment Object ### Description The `Employment` object is used to represent an employment position at a company. These are associated with the employee filling the role.  ### Usage Example Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employees.
+  # # The Employment Object ### Description The `Employment` object is used to represent an employment position at a company. These are associated with the employee filling the role.  Please note: Employment objects are constructed if the object does not exist in the remote system.  ### Usage Example Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employees.
   class Employment
     attr_accessor :id
 
@@ -38,6 +38,8 @@ module MergeHRISClient
     # The position's currency code.
     attr_accessor :pay_currency
 
+    attr_accessor :pay_group
+
     # The position's FLSA status.
     attr_accessor :flsa_status
 
@@ -60,6 +62,7 @@ module MergeHRISClient
         :'pay_period' => :'pay_period',
         :'pay_frequency' => :'pay_frequency',
         :'pay_currency' => :'pay_currency',
+        :'pay_group' => :'pay_group',
         :'flsa_status' => :'flsa_status',
         :'effective_date' => :'effective_date',
         :'employment_type' => :'employment_type',
@@ -83,6 +86,7 @@ module MergeHRISClient
         :'pay_period' => :'PayPeriodEnum',
         :'pay_frequency' => :'PayFrequencyEnum',
         :'pay_currency' => :'PayCurrencyEnum',
+        :'pay_group' => :'String',
         :'flsa_status' => :'FlsaStatusEnum',
         :'effective_date' => :'Time',
         :'employment_type' => :'EmploymentTypeEnum',
@@ -100,6 +104,7 @@ module MergeHRISClient
         :'pay_period',
         :'pay_frequency',
         :'pay_currency',
+        :'pay_group',
         :'flsa_status',
         :'effective_date',
         :'employment_type',
@@ -154,6 +159,10 @@ module MergeHRISClient
         self.pay_currency = attributes[:'pay_currency']
       end
 
+      if attributes.key?(:'pay_group')
+        self.pay_group = attributes[:'pay_group']
+      end
+
       if attributes.key?(:'flsa_status')
         self.flsa_status = attributes[:'flsa_status']
       end
@@ -199,6 +208,7 @@ module MergeHRISClient
           pay_period == o.pay_period &&
           pay_frequency == o.pay_frequency &&
           pay_currency == o.pay_currency &&
+          pay_group == o.pay_group &&
           flsa_status == o.flsa_status &&
           effective_date == o.effective_date &&
           employment_type == o.employment_type &&
@@ -214,7 +224,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, flsa_status, effective_date, employment_type, 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_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/end_user_details_request.rb

@@ -23,8 +23,10 @@ module MergeHRISClient
 
     attr_accessor :categories
 
+    # The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see https://www.merge.dev/docs/basics/integration-metadata
     attr_accessor :integration
 
+    # An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30
     attr_accessor :link_expiry_mins
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -115,6 +117,10 @@ module MergeHRISClient
         invalid_properties.push('invalid value for "end_user_email_address", end_user_email_address cannot be nil.')
       end
 
+      if @end_user_email_address.to_s.length > 100
+        invalid_properties.push('invalid value for "end_user_email_address", the character length must be smaller than or equal to 100.')
+      end
+
       if @end_user_email_address.to_s.length < 1
         invalid_properties.push('invalid value for "end_user_email_address", the character length must be great than or equal to 1.')
       end
@@ -123,6 +129,10 @@ module MergeHRISClient
         invalid_properties.push('invalid value for "end_user_organization_name", end_user_organization_name cannot be nil.')
       end
 
+      if @end_user_organization_name.to_s.length > 100
+        invalid_properties.push('invalid value for "end_user_organization_name", the character length must be smaller than or equal to 100.')
+      end
+
       if @end_user_organization_name.to_s.length < 1
         invalid_properties.push('invalid value for "end_user_organization_name", the character length must be great than or equal to 1.')
       end
@@ -131,10 +141,18 @@ module MergeHRISClient
         invalid_properties.push('invalid value for "end_user_origin_id", end_user_origin_id cannot be nil.')
       end
 
+      if @end_user_origin_id.to_s.length > 100
+        invalid_properties.push('invalid value for "end_user_origin_id", the character length must be smaller than or equal to 100.')
+      end
+
       if @end_user_origin_id.to_s.length < 1
         invalid_properties.push('invalid value for "end_user_origin_id", the character length must be great than or equal to 1.')
       end
 
+      if @categories.nil?
+        invalid_properties.push('invalid value for "categories", categories cannot be nil.')
+      end
+
       if !@integration.nil? && @integration.to_s.length < 1
         invalid_properties.push('invalid value for "integration", the character length must be great than or equal to 1.')
       end
@@ -154,11 +172,15 @@ module MergeHRISClient
     # @return true if the model is valid
     def valid?
       return false if @end_user_email_address.nil?
+      return false if @end_user_email_address.to_s.length > 100
       return false if @end_user_email_address.to_s.length < 1
       return false if @end_user_organization_name.nil?
+      return false if @end_user_organization_name.to_s.length > 100
       return false if @end_user_organization_name.to_s.length < 1
       return false if @end_user_origin_id.nil?
+      return false if @end_user_origin_id.to_s.length > 100
       return false if @end_user_origin_id.to_s.length < 1
+      return false if @categories.nil?
       return false if !@integration.nil? && @integration.to_s.length < 1
       return false if !@link_expiry_mins.nil? && @link_expiry_mins > 720
       return false if !@link_expiry_mins.nil? && @link_expiry_mins < 30
@@ -172,6 +194,10 @@ module MergeHRISClient
         fail ArgumentError, 'end_user_email_address cannot be nil'
       end
 
+      if end_user_email_address.to_s.length > 100
+        fail ArgumentError, 'invalid value for "end_user_email_address", the character length must be smaller than or equal to 100.'
+      end
+
       if end_user_email_address.to_s.length < 1
         fail ArgumentError, 'invalid value for "end_user_email_address", the character length must be great than or equal to 1.'
       end
@@ -186,6 +212,10 @@ module MergeHRISClient
         fail ArgumentError, 'end_user_organization_name cannot be nil'
       end
 
+      if end_user_organization_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "end_user_organization_name", the character length must be smaller than or equal to 100.'
+      end
+
       if end_user_organization_name.to_s.length < 1
         fail ArgumentError, 'invalid value for "end_user_organization_name", the character length must be great than or equal to 1.'
       end
@@ -200,6 +230,10 @@ module MergeHRISClient
         fail ArgumentError, 'end_user_origin_id cannot be nil'
       end
 
+      if end_user_origin_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "end_user_origin_id", the character length must be smaller than or equal to 100.'
+      end
+
       if end_user_origin_id.to_s.length < 1
         fail ArgumentError, 'invalid value for "end_user_origin_id", the character length must be great than or equal to 1.'
       end

data/lib/merge_hris_client/models/group.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The PayGroup Object ### Description The `PayGroup` object is used to represent Group information that employees belong to. This is often referenced with an Employee object.  ### Usage Example Fetch from the `LIST Employee` endpoint and expand groups to view an employees groups.
+  # # The Group Object ### Description The `Group` object is used to represent Group information that employees belong to. This is often referenced with an Employee object.  Please note: The teams object will fulfill most use cases. The Groups object is for power-users that want all types of groups at a company and the optionality of pulling multiple groups for an employee.  ### Usage Example Fetch from the `LIST Employee` endpoint and expand groups to view an employee's groups.
   class Group
     attr_accessor :id
 

data/lib/merge_hris_client/models/linked_account_status.rb

@@ -0,0 +1,237 @@
+=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 LinkedAccountStatus
+    attr_accessor :linked_account_status
+
+    attr_accessor :can_make_request
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'linked_account_status' => :'linked_account_status',
+        :'can_make_request' => :'can_make_request'
+      }
+    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
+      {
+        :'linked_account_status' => :'String',
+        :'can_make_request' => :'Boolean'
+      }
+    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 `MergeHRISClient::LinkedAccountStatus` 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::LinkedAccountStatus`. 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?(:'linked_account_status')
+        self.linked_account_status = attributes[:'linked_account_status']
+      end
+
+      if attributes.key?(:'can_make_request')
+        self.can_make_request = attributes[:'can_make_request']
+      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 @linked_account_status.nil?
+        invalid_properties.push('invalid value for "linked_account_status", linked_account_status cannot be nil.')
+      end
+
+      if @can_make_request.nil?
+        invalid_properties.push('invalid value for "can_make_request", can_make_request 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?
+      return false if @linked_account_status.nil?
+      return false if @can_make_request.nil?
+      true
+    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 &&
+          linked_account_status == o.linked_account_status &&
+          can_make_request == o.can_make_request
+    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
+      [linked_account_status, can_make_request].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/location.rb

@@ -39,7 +39,7 @@ module MergeHRISClient
     # The location's state. Represents a region if outside of the US.
     attr_accessor :state
 
-    # The location's zip code.
+    # The location's zip code or postal code.
     attr_accessor :zip_code
 
     # The location's country.