merge_hris_client 3.0.0 → 3.2.0

data/lib/merge_hris_client/models/account_integration.rb

@@ -18,7 +18,7 @@ module MergeHRISClient
     # Company name.
     attr_accessor :name
 
-    # Category or categories this integration belongs to. Multiple categories should be comma separated.<br/><br>Example: For [ats, hris], enter <i>ats,hris</i>
+    # Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris].
     attr_accessor :categories
 
     # Company logo in rectangular shape. <b>Upload an image with a clear background.</b>
@@ -32,6 +32,12 @@ module MergeHRISClient
 
     attr_accessor :slug
 
+    # If checked, this integration will not appear in the linking flow, and will appear elsewhere with a Beta tag.
+    attr_accessor :is_in_beta
+
+    # Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}
+    attr_accessor :api_endpoints_to_documentation_urls
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +46,9 @@ module MergeHRISClient
         :'image' => :'image',
         :'square_image' => :'square_image',
         :'color' => :'color',
-        :'slug' => :'slug'
+        :'slug' => :'slug',
+        :'is_in_beta' => :'is_in_beta',
+        :'api_endpoints_to_documentation_urls' => :'api_endpoints_to_documentation_urls'
       }
     end
 
@@ -57,7 +65,9 @@ module MergeHRISClient
         :'image' => :'String',
         :'square_image' => :'String',
         :'color' => :'String',
-        :'slug' => :'String'
+        :'slug' => :'String',
+        :'is_in_beta' => :'Boolean',
+        :'api_endpoints_to_documentation_urls' => :'Hash<String, Object>'
       }
     end
 
@@ -109,6 +119,16 @@ module MergeHRISClient
       if attributes.key?(:'slug')
         self.slug = attributes[:'slug']
       end
+
+      if attributes.key?(:'is_in_beta')
+        self.is_in_beta = attributes[:'is_in_beta']
+      end
+
+      if attributes.key?(:'api_endpoints_to_documentation_urls')
+        if (value = attributes[:'api_endpoints_to_documentation_urls']).is_a?(Hash)
+          self.api_endpoints_to_documentation_urls = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -124,7 +144,7 @@ module MergeHRISClient
       end
 
       pattern = Regexp.new(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
-      if !@color.nil? && @color !~ pattern
+      if !@color.nil? && @color.to_s !~ pattern
         invalid_properties.push("invalid value for \"color\", must conform to the pattern #{pattern}.")
       end
 
@@ -136,7 +156,7 @@ module MergeHRISClient
     def valid?
       return false if @name.nil?
       return false if !@color.nil? && @color.to_s.length > 18
-      return false if !@color.nil? && @color !~ Regexp.new(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
+      return false if !@color.nil? && @color.to_s !~ Regexp.new(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
       true
     end
 
@@ -148,7 +168,7 @@ module MergeHRISClient
       end
 
       pattern = Regexp.new(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
-      if !color.nil? && color !~ pattern
+      if !color.nil? && color.to_s !~ pattern
         fail ArgumentError, "invalid value for \"color\", must conform to the pattern #{pattern}."
       end
 
@@ -165,7 +185,9 @@ module MergeHRISClient
           image == o.image &&
           square_image == o.square_image &&
           color == o.color &&
-          slug == o.slug
+          slug == o.slug &&
+          is_in_beta == o.is_in_beta &&
+          api_endpoints_to_documentation_urls == o.api_endpoints_to_documentation_urls
     end
 
     # @see the `==` method
@@ -177,7 +199,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, categories, image, square_image, color, slug].hash
+      [name, categories, image, square_image, color, slug, is_in_beta, api_endpoints_to_documentation_urls].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/bank_info.rb

@@ -14,13 +14,14 @@ 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.
+  # # The BankInfo Object ### Description The `BankInfo` object is used to represent the Bank Account information for an Employee.  ### 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.
@@ -32,17 +33,22 @@ module MergeHRISClient
     # The bank name.
     attr_accessor :bank_name
 
-    # The bank account type
+    # The bank account type  * `SAVINGS` - SAVINGS * `CHECKING` - CHECKING
     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
-
     # 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 :remote_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -54,8 +60,10 @@ module MergeHRISClient
         :'bank_name' => :'bank_name',
         :'account_type' => :'account_type',
         :'remote_created_at' => :'remote_created_at',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -75,8 +83,10 @@ module MergeHRISClient
         :'bank_name' => :'String',
         :'account_type' => :'AccountTypeEnum',
         :'remote_created_at' => :'Time',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -90,7 +100,8 @@ module MergeHRISClient
         :'bank_name',
         :'account_type',
         :'remote_created_at',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -141,15 +152,25 @@ module MergeHRISClient
         self.remote_created_at = attributes[:'remote_created_at']
       end
 
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      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
         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?
@@ -193,8 +214,10 @@ module MergeHRISClient
           bank_name == o.bank_name &&
           account_type == o.account_type &&
           remote_created_at == o.remote_created_at &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          modified_at == o.modified_at &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -206,7 +229,7 @@ module MergeHRISClient
     # 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, remote_was_deleted].hash
+      [id, remote_id, employee, account_number, routing_number, bank_name, account_type, remote_created_at, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

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,16 @@ module MergeHRISClient
     # The company's contribution.
     attr_accessor :company_contribution
 
-    attr_accessor :remote_data
-
     # 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 :remote_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -50,8 +56,10 @@ 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'
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -70,8 +78,10 @@ module MergeHRISClient
         :'benefit_plan_type' => :'String',
         :'employee_contribution' => :'Float',
         :'company_contribution' => :'Float',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -84,7 +94,8 @@ module MergeHRISClient
         :'benefit_plan_type',
         :'employee_contribution',
         :'company_contribution',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -131,15 +142,25 @@ module MergeHRISClient
         self.company_contribution = attributes[:'company_contribution']
       end
 
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      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
         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?
@@ -167,8 +188,10 @@ 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
+          remote_was_deleted == o.remote_was_deleted &&
+          field_mappings == o.field_mappings &&
+          modified_at == o.modified_at &&
+          remote_data == o.remote_data
     end
 
     # @see the `==` method
@@ -180,7 +203,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, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

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