merge_hris_client 3.2.1 → 3.2.2

data/lib/merge_hris_client/models/end_user_details_request.rb

@@ -27,7 +27,7 @@ module MergeHRISClient
     # The integration categories to show in Merge Link.
     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/.
+    # The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
     attr_accessor :integration
 
     # 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.
@@ -39,6 +39,15 @@ module MergeHRISClient
     # 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.
     attr_accessor :common_models
 
+    # When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+    attr_accessor :category_common_model_scopes
+
+    # The language code for the language to localize Merge Link to.
+    attr_accessor :language
+
+    # A JSON object containing integration-specific configuration options.
+    attr_accessor :integration_specific_config
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,7 +58,10 @@ module MergeHRISClient
         :'integration' => :'integration',
         :'link_expiry_mins' => :'link_expiry_mins',
         :'should_create_magic_link_url' => :'should_create_magic_link_url',
-        :'common_models' => :'common_models'
+        :'common_models' => :'common_models',
+        :'category_common_model_scopes' => :'category_common_model_scopes',
+        :'language' => :'language',
+        :'integration_specific_config' => :'integration_specific_config'
       }
     end
 
@@ -68,7 +80,10 @@ module MergeHRISClient
         :'integration' => :'String',
         :'link_expiry_mins' => :'Integer',
         :'should_create_magic_link_url' => :'Boolean',
-        :'common_models' => :'Array<CommonModelScopesBodyRequest>'
+        :'common_models' => :'Array<CommonModelScopesBodyRequest>',
+        :'category_common_model_scopes' => :'Hash<String, Array<IndividualCommonModelScopeDeserializerRequest>>',
+        :'language' => :'String',
+        :'integration_specific_config' => :'Hash<String, Object>'
       }
     end
 
@@ -77,7 +92,10 @@ module MergeHRISClient
       Set.new([
         :'integration',
         :'should_create_magic_link_url',
-        :'common_models'
+        :'common_models',
+        :'category_common_model_scopes',
+        :'language',
+        :'integration_specific_config'
       ])
     end
 
@@ -135,6 +153,22 @@ module MergeHRISClient
           self.common_models = value
         end
       end
+
+      if attributes.key?(:'category_common_model_scopes')
+        if (value = attributes[:'category_common_model_scopes']).is_a?(Hash)
+          self.category_common_model_scopes = value
+        end
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'integration_specific_config')
+        if (value = attributes[:'integration_specific_config']).is_a?(Hash)
+          self.integration_specific_config = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -193,6 +227,14 @@ module MergeHRISClient
         invalid_properties.push('invalid value for "link_expiry_mins", must be greater than or equal to 30.')
       end
 
+      if !@language.nil? && @language.to_s.length > 2
+        invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@language.nil? && @language.to_s.length < 1
+        invalid_properties.push('invalid value for "language", the character length must be great than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -212,6 +254,8 @@ module MergeHRISClient
       return false if !@integration.nil? && @integration.to_s.length < 1
       return false if !@link_expiry_mins.nil? && @link_expiry_mins > 10080
       return false if !@link_expiry_mins.nil? && @link_expiry_mins < 30
+      return false if !@language.nil? && @language.to_s.length > 2
+      return false if !@language.nil? && @language.to_s.length < 1
       true
     end
 
@@ -293,6 +337,20 @@ module MergeHRISClient
       @link_expiry_mins = link_expiry_mins
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] language Value to be assigned
+    def language=(language)
+      if !language.nil? && language.to_s.length > 2
+        fail ArgumentError, 'invalid value for "language", the character length must be smaller than or equal to 2.'
+      end
+
+      if !language.nil? && language.to_s.length < 1
+        fail ArgumentError, 'invalid value for "language", the character length must be great than or equal to 1.'
+      end
+
+      @language = language
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -305,7 +363,10 @@ module MergeHRISClient
           integration == o.integration &&
           link_expiry_mins == o.link_expiry_mins &&
           should_create_magic_link_url == o.should_create_magic_link_url &&
-          common_models == o.common_models
+          common_models == o.common_models &&
+          category_common_model_scopes == o.category_common_model_scopes &&
+          language == o.language &&
+          integration_specific_config == o.integration_specific_config
     end
 
     # @see the `==` method
@@ -317,7 +378,7 @@ module MergeHRISClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [end_user_email_address, end_user_organization_name, end_user_origin_id, categories, integration, link_expiry_mins, should_create_magic_link_url, common_models].hash
+      [end_user_email_address, end_user_organization_name, end_user_origin_id, categories, integration, link_expiry_mins, should_create_magic_link_url, common_models, category_common_model_scopes, language, integration_specific_config].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/event_type_enum.rb

@@ -0,0 +1,81 @@
+=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 EventTypeEnum
+    CREATED_REMOTE_PRODUCTION_API_KEY = "CREATED_REMOTE_PRODUCTION_API_KEY".freeze
+    DELETED_REMOTE_PRODUCTION_API_KEY = "DELETED_REMOTE_PRODUCTION_API_KEY".freeze
+    CREATED_TEST_API_KEY = "CREATED_TEST_API_KEY".freeze
+    DELETED_TEST_API_KEY = "DELETED_TEST_API_KEY".freeze
+    REGENERATED_PRODUCTION_API_KEY = "REGENERATED_PRODUCTION_API_KEY".freeze
+    INVITED_USER = "INVITED_USER".freeze
+    TWO_FACTOR_AUTH_ENABLED = "TWO_FACTOR_AUTH_ENABLED".freeze
+    TWO_FACTOR_AUTH_DISABLED = "TWO_FACTOR_AUTH_DISABLED".freeze
+    DELETED_LINKED_ACCOUNT = "DELETED_LINKED_ACCOUNT".freeze
+    CREATED_DESTINATION = "CREATED_DESTINATION".freeze
+    DELETED_DESTINATION = "DELETED_DESTINATION".freeze
+    CHANGED_DESTINATION = "CHANGED_DESTINATION".freeze
+    CHANGED_SCOPES = "CHANGED_SCOPES".freeze
+    CHANGED_PERSONAL_INFORMATION = "CHANGED_PERSONAL_INFORMATION".freeze
+    CHANGED_ORGANIZATION_SETTINGS = "CHANGED_ORGANIZATION_SETTINGS".freeze
+    ENABLED_INTEGRATION = "ENABLED_INTEGRATION".freeze
+    DISABLED_INTEGRATION = "DISABLED_INTEGRATION".freeze
+    ENABLED_CATEGORY = "ENABLED_CATEGORY".freeze
+    DISABLED_CATEGORY = "DISABLED_CATEGORY".freeze
+    CHANGED_PASSWORD = "CHANGED_PASSWORD".freeze
+    RESET_PASSWORD = "RESET_PASSWORD".freeze
+    ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION = "ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION".freeze
+    ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT = "ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT".freeze
+    DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION = "DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION".freeze
+    DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT = "DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT".freeze
+    CREATED_INTEGRATION_WIDE_FIELD_MAPPING = "CREATED_INTEGRATION_WIDE_FIELD_MAPPING".freeze
+    CREATED_LINKED_ACCOUNT_FIELD_MAPPING = "CREATED_LINKED_ACCOUNT_FIELD_MAPPING".freeze
+    CHANGED_INTEGRATION_WIDE_FIELD_MAPPING = "CHANGED_INTEGRATION_WIDE_FIELD_MAPPING".freeze
+    CHANGED_LINKED_ACCOUNT_FIELD_MAPPING = "CHANGED_LINKED_ACCOUNT_FIELD_MAPPING".freeze
+    DELETED_INTEGRATION_WIDE_FIELD_MAPPING = "DELETED_INTEGRATION_WIDE_FIELD_MAPPING".freeze
+    DELETED_LINKED_ACCOUNT_FIELD_MAPPING = "DELETED_LINKED_ACCOUNT_FIELD_MAPPING".freeze
+    FORCED_LINKED_ACCOUNT_RESYNC = "FORCED_LINKED_ACCOUNT_RESYNC".freeze
+    MUTED_ISSUE = "MUTED_ISSUE".freeze
+    GENERATED_MAGIC_LINK = "GENERATED_MAGIC_LINK".freeze
+    ENABLED_MERGE_WEBHOOK = "ENABLED_MERGE_WEBHOOK".freeze
+    DISABLED_MERGE_WEBHOOK = "DISABLED_MERGE_WEBHOOK".freeze
+    MERGE_WEBHOOK_TARGET_CHANGED = "MERGE_WEBHOOK_TARGET_CHANGED".freeze
+    END_USER_CREDENTIALS_ACCESSED = "END_USER_CREDENTIALS_ACCESSED".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 ["CREATED_REMOTE_PRODUCTION_API_KEY", "DELETED_REMOTE_PRODUCTION_API_KEY", "CREATED_TEST_API_KEY", "DELETED_TEST_API_KEY", "REGENERATED_PRODUCTION_API_KEY", "INVITED_USER", "TWO_FACTOR_AUTH_ENABLED", "TWO_FACTOR_AUTH_DISABLED", "DELETED_LINKED_ACCOUNT", "CREATED_DESTINATION", "DELETED_DESTINATION", "CHANGED_DESTINATION", "CHANGED_SCOPES", "CHANGED_PERSONAL_INFORMATION", "CHANGED_ORGANIZATION_SETTINGS", "ENABLED_INTEGRATION", "DISABLED_INTEGRATION", "ENABLED_CATEGORY", "DISABLED_CATEGORY", "CHANGED_PASSWORD", "RESET_PASSWORD", "ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION", "ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT", "DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION", "DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT", "CREATED_INTEGRATION_WIDE_FIELD_MAPPING", "CREATED_LINKED_ACCOUNT_FIELD_MAPPING", "CHANGED_INTEGRATION_WIDE_FIELD_MAPPING", "CHANGED_LINKED_ACCOUNT_FIELD_MAPPING", "DELETED_INTEGRATION_WIDE_FIELD_MAPPING", "DELETED_LINKED_ACCOUNT_FIELD_MAPPING", "FORCED_LINKED_ACCOUNT_RESYNC", "MUTED_ISSUE", "GENERATED_MAGIC_LINK", "ENABLED_MERGE_WEBHOOK", "DISABLED_MERGE_WEBHOOK", "MERGE_WEBHOOK_TARGET_CHANGED", "END_USER_CREDENTIALS_ACCESSED", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      EventTypeEnum.new.build_from_hash(value)
+    end
+  end
+
+end

data/lib/merge_hris_client/models/external_target_field_api.rb

@@ -0,0 +1,239 @@
+=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 ExternalTargetFieldAPI
+    attr_accessor :name
+
+    attr_accessor :description
+
+    attr_accessor :is_mapped
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'description' => :'description',
+        :'is_mapped' => :'is_mapped'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'is_mapped' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'description',
+        :'is_mapped'
+      ])
+    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::ExternalTargetFieldAPI` 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::ExternalTargetFieldAPI`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'is_mapped')
+        self.is_mapped = attributes[:'is_mapped']
+      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 &&
+          name == o.name &&
+          description == o.description &&
+          is_mapped == o.is_mapped
+    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
+      [name, description, is_mapped].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