merge_hris_client 3.0.0 → 3.2.1

data/lib/merge_hris_client/models/benefit.rb

@@ -14,13 +14,14 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The Benefit Object ### Description The `Benefit` object is used to represent a Benefit for an employee.  ### Usage Example Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits.
+  # # The Benefit Object ### Description The `Benefit` object is used to represent a benefit that an employee has enrolled in.  ### Usage Example Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits.
   class Benefit
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
+    # The employee on the plan.
     attr_accessor :employee
 
     # The name of the benefit provider.
@@ -35,11 +36,25 @@ module MergeHRISClient
     # The company's contribution.
     attr_accessor :company_contribution
 
-    attr_accessor :remote_data
+    # The day and time the benefit started.
+    attr_accessor :start_date
+
+    # The day and time the benefit ended.
+    attr_accessor :end_date
 
     # Indicates whether or not this object has been deleted by third party webhooks.
     attr_accessor :remote_was_deleted
 
+    # The employer benefit plan the employee is enrolled in.
+    attr_accessor :employer_benefit
+
+    # 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
       {
@@ -50,8 +65,13 @@ module MergeHRISClient
         :'benefit_plan_type' => :'benefit_plan_type',
         :'employee_contribution' => :'employee_contribution',
         :'company_contribution' => :'company_contribution',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'start_date' => :'start_date',
+        :'end_date' => :'end_date',
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'employer_benefit' => :'employer_benefit',
+        :'modified_at' => :'modified_at',
+        :'field_mappings' => :'field_mappings',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -70,8 +90,13 @@ module MergeHRISClient
         :'benefit_plan_type' => :'String',
         :'employee_contribution' => :'Float',
         :'company_contribution' => :'Float',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'start_date' => :'Time',
+        :'end_date' => :'Time',
+        :'remote_was_deleted' => :'Boolean',
+        :'employer_benefit' => :'String',
+        :'modified_at' => :'Time',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -84,7 +109,11 @@ module MergeHRISClient
         :'benefit_plan_type',
         :'employee_contribution',
         :'company_contribution',
-        :'remote_data',
+        :'start_date',
+        :'end_date',
+        :'employer_benefit',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -131,15 +160,37 @@ module MergeHRISClient
         self.company_contribution = attributes[:'company_contribution']
       end
 
-      if attributes.key?(:'remote_data')
-        if (value = attributes[:'remote_data']).is_a?(Array)
-          self.remote_data = value
-        end
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
       end
 
       if attributes.key?(:'remote_was_deleted')
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
+
+      if attributes.key?(:'employer_benefit')
+        self.employer_benefit = attributes[:'employer_benefit']
+      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?
@@ -167,8 +218,13 @@ module MergeHRISClient
           benefit_plan_type == o.benefit_plan_type &&
           employee_contribution == o.employee_contribution &&
           company_contribution == o.company_contribution &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          remote_was_deleted == o.remote_was_deleted &&
+          employer_benefit == o.employer_benefit &&
+          modified_at == o.modified_at &&
+          field_mappings == o.field_mappings &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -180,7 +236,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee, provider_name, benefit_plan_type, employee_contribution, company_contribution, remote_data, remote_was_deleted].hash
+      [id, remote_id, employee, provider_name, benefit_plan_type, employee_contribution, company_contribution, start_date, end_date, remote_was_deleted, employer_benefit, modified_at, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/benefit_plan_type_enum.rb

@@ -0,0 +1,48 @@
+=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 BenefitPlanTypeEnum
+    MEDICAL = "MEDICAL".freeze
+    HEALTH_SAVINGS = "HEALTH_SAVINGS".freeze
+    INSURANCE = "INSURANCE".freeze
+    RETIREMENT = "RETIREMENT".freeze
+    OTHER = "OTHER".freeze
+
+    MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
+
+    attr_accessor :value
+    attr_accessor :raw_value
+
+    # 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)
+      @raw_value = value
+      if ["MEDICAL", "HEALTH_SAVINGS", "INSURANCE", "RETIREMENT", "OTHER", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      BenefitPlanTypeEnum.new.build_from_hash(value)
+    end
+  end
+
+end

data/lib/merge_hris_client/models/categories_enum.rb

@@ -20,6 +20,8 @@ module MergeHRISClient
     ACCOUNTING = "accounting".freeze
     TICKETING = "ticketing".freeze
     CRM = "crm".freeze
+    MKTG = "mktg".freeze
+    FILESTORAGE = "filestorage".freeze
 
     MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
 
@@ -31,7 +33,7 @@ module MergeHRISClient
     # @return [String] The enum value
     def build_from_hash(value)
       @raw_value = value
-      if ["hris", "ats", "accounting", "ticketing", "crm", ].include? value
+      if ["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage", ].include? value
         @value = value
       else
         @value = MERGE_NONSTANDARD_VALUE

data/lib/merge_hris_client/models/category_enum.rb

@@ -20,6 +20,8 @@ module MergeHRISClient
     ACCOUNTING = "accounting".freeze
     TICKETING = "ticketing".freeze
     CRM = "crm".freeze
+    MKTG = "mktg".freeze
+    FILESTORAGE = "filestorage".freeze
 
     MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
 
@@ -31,7 +33,7 @@ module MergeHRISClient
     # @return [String] The enum value
     def build_from_hash(value)
       @raw_value = value
-      if ["hris", "ats", "accounting", "ticketing", "crm", ].include? value
+      if ["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage", ].include? value
         @value = value
       else
         @value = MERGE_NONSTANDARD_VALUE

data/lib/merge_hris_client/models/common_model_scope_data.rb

@@ -0,0 +1,234 @@
+=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 CommonModelScopeData
+    attr_accessor :common_models
+
+    attr_accessor :linked_account_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'common_models' => :'common_models',
+        :'linked_account_id' => :'linked_account_id'
+      }
+    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
+      {
+        :'common_models' => :'Array<CommonModelScopesDisabledModels>',
+        :'linked_account_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 `MergeHRISClient::CommonModelScopeData` 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::CommonModelScopeData`. 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?(:'common_models')
+        if (value = attributes[:'common_models']).is_a?(Array)
+          self.common_models = value
+        end
+      end
+
+      if attributes.key?(:'linked_account_id')
+        self.linked_account_id = attributes[:'linked_account_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
+      invalid_properties = Array.new
+      if @common_models.nil?
+        invalid_properties.push('invalid value for "common_models", common_models 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 @common_models.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 &&
+          common_models == o.common_models &&
+          linked_account_id == o.linked_account_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
+      [common_models, linked_account_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)
+      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