merge_hris_client 2.0.4 → 3.2.2

data/lib/merge_hris_client/models/time_off_balance.rb

@@ -14,40 +14,52 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The TimeOffBalance Object ### Description The `TimeOffBalance` object is used to represent a Time Off Balance for an employee.  ### Usage Example Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all time off balances.
+  # # The TimeOffBalance Object ### Description The `TimeOffBalance` object is used to represent current balances for an employee's Time Off plan.  ### Usage Example Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all time off balances.
   class TimeOffBalance
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
+    # The datetime that this object was created by Merge.
+    attr_accessor :created_at
+
+    # The datetime that this object was modified by Merge.
+    attr_accessor :modified_at
+
+    # The employee the balance belongs to.
     attr_accessor :employee
 
-    # The current remaining PTO balance in terms of hours. This does not represent the starting PTO balance. If the API provider only provides PTO balance in terms of days, we estimate 8 hours per day.
+    # The current remaining PTO balance, always measured in terms of hours.
     attr_accessor :balance
 
     # The amount of PTO used in terms of hours.
     attr_accessor :used
 
-    # The policy type of this time off balance.
+    # The policy type of this time off balance.  * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
     attr_accessor :policy_type
 
-    attr_accessor :remote_data
-
-    # Indicates whether or not this object has been deleted by third party webhooks.
+    # Indicates whether or not this object has been deleted in the third party platform.
     attr_accessor :remote_was_deleted
 
+    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',
+        :'created_at' => :'created_at',
+        :'modified_at' => :'modified_at',
         :'employee' => :'employee',
         :'balance' => :'balance',
         :'used' => :'used',
         :'policy_type' => :'policy_type',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -61,12 +73,15 @@ module MergeHRISClient
       {
         :'id' => :'String',
         :'remote_id' => :'String',
+        :'created_at' => :'Time',
+        :'modified_at' => :'Time',
         :'employee' => :'String',
         :'balance' => :'Float',
         :'used' => :'Float',
         :'policy_type' => :'PolicyTypeEnum',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Object',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -78,7 +93,8 @@ module MergeHRISClient
         :'balance',
         :'used',
         :'policy_type',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -105,6 +121,14 @@ module MergeHRISClient
         self.remote_id = attributes[:'remote_id']
       end
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
       if attributes.key?(:'employee')
         self.employee = attributes[:'employee']
       end
@@ -121,15 +145,19 @@ module MergeHRISClient
         self.policy_type = attributes[:'policy_type']
       end
 
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      end
+
+      if attributes.key?(:'field_mappings')
+        self.field_mappings = attributes[:'field_mappings']
+      end
+
       if attributes.key?(:'remote_data')
         if (value = attributes[:'remote_data']).is_a?(Array)
           self.remote_data = value
         end
       end
-
-      if attributes.key?(:'remote_was_deleted')
-        self.remote_was_deleted = attributes[:'remote_was_deleted']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -152,12 +180,15 @@ module MergeHRISClient
       self.class == o.class &&
           id == o.id &&
           remote_id == o.remote_id &&
+          created_at == o.created_at &&
+          modified_at == o.modified_at &&
           employee == o.employee &&
           balance == o.balance &&
           used == o.used &&
           policy_type == o.policy_type &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -169,7 +200,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, employee, balance, used, policy_type, remote_data, remote_was_deleted].hash
+      [id, remote_id, created_at, modified_at, employee, balance, used, policy_type, remote_was_deleted, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/time_off_request.rb

@@ -14,28 +14,27 @@ require 'date'
 require 'time'
 
 module MergeHRISClient
-  # # The TimeOff Object ### Description The `TimeOff` object is used to represent a Time Off Request filed by an employee.  ### Usage Example Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.
+  # # The TimeOff Object ### Description The `TimeOff` object is used to represent all employees' Time Off entries.  ### Usage Example Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.
   class TimeOffRequest
-    # The third-party API ID of the matching object.
-    attr_accessor :remote_id
-
+    # The employee requesting time off.
     attr_accessor :employee
 
+    # The Merge ID of the employee with the ability to approve the time off request.
     attr_accessor :approver
 
-    # The status of this time off request.
+    # The status of this time off request.  * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
     attr_accessor :status
 
     # The employee note for this time off request.
     attr_accessor :employee_note
 
-    # The unit of time requested.
+    # The measurement that the third-party integration uses to count time requested.  * `HOURS` - HOURS * `DAYS` - DAYS
     attr_accessor :units
 
-    # The number of time off units requested.
+    # The time off quantity measured by the prescribed “units”.
     attr_accessor :amount
 
-    # The type of time off request.
+    # The type of time off request.  * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
     attr_accessor :request_type
 
     # The day and time of the start of the time requested off.
@@ -44,10 +43,13 @@ module MergeHRISClient
     # The day and time of the end of the time requested off.
     attr_accessor :end_time
 
+    attr_accessor :integration_params
+
+    attr_accessor :linked_account_params
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'remote_id' => :'remote_id',
         :'employee' => :'employee',
         :'approver' => :'approver',
         :'status' => :'status',
@@ -56,7 +58,9 @@ module MergeHRISClient
         :'amount' => :'amount',
         :'request_type' => :'request_type',
         :'start_time' => :'start_time',
-        :'end_time' => :'end_time'
+        :'end_time' => :'end_time',
+        :'integration_params' => :'integration_params',
+        :'linked_account_params' => :'linked_account_params'
       }
     end
 
@@ -68,7 +72,6 @@ module MergeHRISClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'remote_id' => :'String',
         :'employee' => :'String',
         :'approver' => :'String',
         :'status' => :'TimeOffStatusEnum',
@@ -77,14 +80,15 @@ module MergeHRISClient
         :'amount' => :'Float',
         :'request_type' => :'RequestTypeEnum',
         :'start_time' => :'Time',
-        :'end_time' => :'Time'
+        :'end_time' => :'Time',
+        :'integration_params' => :'Hash<String, Object>',
+        :'linked_account_params' => :'Hash<String, Object>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'remote_id',
         :'employee',
         :'approver',
         :'status',
@@ -93,7 +97,9 @@ module MergeHRISClient
         :'amount',
         :'request_type',
         :'start_time',
-        :'end_time'
+        :'end_time',
+        :'integration_params',
+        :'linked_account_params'
       ])
     end
 
@@ -112,10 +118,6 @@ module MergeHRISClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'remote_id')
-        self.remote_id = attributes[:'remote_id']
-      end
-
       if attributes.key?(:'employee')
         self.employee = attributes[:'employee']
       end
@@ -151,6 +153,18 @@ module MergeHRISClient
       if attributes.key?(:'end_time')
         self.end_time = attributes[:'end_time']
       end
+
+      if attributes.key?(:'integration_params')
+        if (value = attributes[:'integration_params']).is_a?(Hash)
+          self.integration_params = value
+        end
+      end
+
+      if attributes.key?(:'linked_account_params')
+        if (value = attributes[:'linked_account_params']).is_a?(Hash)
+          self.linked_account_params = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -171,7 +185,6 @@ module MergeHRISClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          remote_id == o.remote_id &&
           employee == o.employee &&
           approver == o.approver &&
           status == o.status &&
@@ -180,7 +193,9 @@ module MergeHRISClient
           amount == o.amount &&
           request_type == o.request_type &&
           start_time == o.start_time &&
-          end_time == o.end_time
+          end_time == o.end_time &&
+          integration_params == o.integration_params &&
+          linked_account_params == o.linked_account_params
     end
 
     # @see the `==` method
@@ -192,7 +207,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [remote_id, employee, approver, status, employee_note, units, amount, request_type, start_time, end_time].hash
+      [employee, approver, status, employee_note, units, amount, request_type, start_time, end_time, integration_params, linked_account_params].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/time_off_status_enum.rb

@@ -21,18 +21,28 @@ module MergeHRISClient
     CANCELLED = "CANCELLED".freeze
     DELETED = "DELETED".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
+    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)
-      value
+      @raw_value = value
+      if ["REQUESTED", "APPROVED", "DECLINED", "CANCELLED", "DELETED", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      TimeOffStatusEnum.new.build_from_hash(value)
     end
   end
+
 end

data/lib/merge_hris_client/models/timesheet_entry.rb

@@ -0,0 +1,326 @@
+=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 Timesheet Entry Object ### Description The `Timesheet Entry` object is used to track coverage for hours worked by an 'Employee'.   ### Usage Example GET and POST Timesheet Entries
+  class TimesheetEntry
+    attr_accessor :id
+
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
+    # The datetime that this object was created by Merge.
+    attr_accessor :created_at
+
+    # The datetime that this object was modified by Merge.
+    attr_accessor :modified_at
+
+    # The employee the timesheet entry is for.
+    attr_accessor :employee
+
+    # The number of hours logged by the employee.
+    attr_accessor :hours_worked
+
+    # The time at which the employee started work.
+    attr_accessor :start_time
+
+    # The time at which the employee ended work.
+    attr_accessor :end_time
+
+    # Indicates whether or not this object has been deleted in the third party platform.
+    attr_accessor :remote_was_deleted
+
+    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',
+        :'created_at' => :'created_at',
+        :'modified_at' => :'modified_at',
+        :'employee' => :'employee',
+        :'hours_worked' => :'hours_worked',
+        :'start_time' => :'start_time',
+        :'end_time' => :'end_time',
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'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',
+        :'created_at' => :'Time',
+        :'modified_at' => :'Time',
+        :'employee' => :'String',
+        :'hours_worked' => :'Float',
+        :'start_time' => :'Time',
+        :'end_time' => :'Time',
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Object',
+        :'remote_data' => :'Array<Hash<String, Object>>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remote_id',
+        :'employee',
+        :'hours_worked',
+        :'start_time',
+        :'end_time',
+        :'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::TimesheetEntry` 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::TimesheetEntry`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
+      if attributes.key?(:'employee')
+        self.employee = attributes[:'employee']
+      end
+
+      if attributes.key?(:'hours_worked')
+        self.hours_worked = attributes[:'hours_worked']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'end_time')
+        self.end_time = attributes[:'end_time']
+      end
+
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      end
+
+      if attributes.key?(:'field_mappings')
+        self.field_mappings = attributes[:'field_mappings']
+      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
+      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?
+      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 &&
+          id == o.id &&
+          remote_id == o.remote_id &&
+          created_at == o.created_at &&
+          modified_at == o.modified_at &&
+          employee == o.employee &&
+          hours_worked == o.hours_worked &&
+          start_time == o.start_time &&
+          end_time == o.end_time &&
+          remote_was_deleted == o.remote_was_deleted &&
+          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, created_at, modified_at, employee, hours_worked, start_time, end_time, remote_was_deleted, 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