merge_hris_client 2.0.4 → 3.2.2

data/lib/merge_hris_client/models/account_integration.rb

@@ -18,7 +18,10 @@ 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>
+    # Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).<br><br>Example: <i>Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)</i>
+    attr_accessor :abbreviated_name
+
+    # 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,15 +35,28 @@ module MergeHRISClient
 
     attr_accessor :slug
 
+    # 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
+
+    # Setup guide URL for third party webhook creation. Exposed in Merge Docs.
+    attr_accessor :webhook_setup_guide_url
+
+    # Category or categories this integration is in beta status for.
+    attr_accessor :category_beta_status
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
+        :'abbreviated_name' => :'abbreviated_name',
         :'categories' => :'categories',
         :'image' => :'image',
         :'square_image' => :'square_image',
         :'color' => :'color',
-        :'slug' => :'slug'
+        :'slug' => :'slug',
+        :'api_endpoints_to_documentation_urls' => :'api_endpoints_to_documentation_urls',
+        :'webhook_setup_guide_url' => :'webhook_setup_guide_url',
+        :'category_beta_status' => :'category_beta_status'
       }
     end
 
@@ -53,19 +69,25 @@ module MergeHRISClient
     def self.openapi_types
       {
         :'name' => :'String',
+        :'abbreviated_name' => :'String',
         :'categories' => :'Array<CategoriesEnum>',
         :'image' => :'String',
         :'square_image' => :'String',
         :'color' => :'String',
-        :'slug' => :'String'
+        :'slug' => :'String',
+        :'api_endpoints_to_documentation_urls' => :'Hash<String, Object>',
+        :'webhook_setup_guide_url' => :'String',
+        :'category_beta_status' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'abbreviated_name',
         :'image',
         :'square_image',
+        :'webhook_setup_guide_url',
       ])
     end
 
@@ -88,6 +110,10 @@ module MergeHRISClient
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'abbreviated_name')
+        self.abbreviated_name = attributes[:'abbreviated_name']
+      end
+
       if attributes.key?(:'categories')
         if (value = attributes[:'categories']).is_a?(Array)
           self.categories = value
@@ -109,6 +135,20 @@ module MergeHRISClient
       if attributes.key?(:'slug')
         self.slug = attributes[:'slug']
       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
+
+      if attributes.key?(:'webhook_setup_guide_url')
+        self.webhook_setup_guide_url = attributes[:'webhook_setup_guide_url']
+      end
+
+      if attributes.key?(:'category_beta_status')
+        self.category_beta_status = attributes[:'category_beta_status']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -124,7 +164,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 +176,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 +188,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
 
@@ -161,11 +201,15 @@ module MergeHRISClient
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
+          abbreviated_name == o.abbreviated_name &&
           categories == o.categories &&
           image == o.image &&
           square_image == o.square_image &&
           color == o.color &&
-          slug == o.slug
+          slug == o.slug &&
+          api_endpoints_to_documentation_urls == o.api_endpoints_to_documentation_urls &&
+          webhook_setup_guide_url == o.webhook_setup_guide_url &&
+          category_beta_status == o.category_beta_status
     end
 
     # @see the `==` method
@@ -177,7 +221,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, abbreviated_name, categories, image, square_image, color, slug, api_endpoints_to_documentation_urls, webhook_setup_guide_url, category_beta_status].hash
     end
 
     # Builds the object from hash

data/lib/merge_hris_client/models/account_type_enum.rb

@@ -18,18 +18,28 @@ module MergeHRISClient
     SAVINGS = "SAVINGS".freeze
     CHECKING = "CHECKING".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 ["SAVINGS", "CHECKING", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      AccountTypeEnum.new.build_from_hash(value)
     end
   end
+
 end

data/lib/merge_hris_client/models/advanced_metadata.rb

@@ -0,0 +1,270 @@
+=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 AdvancedMetadata
+    attr_accessor :id
+
+    attr_accessor :display_name
+
+    attr_accessor :description
+
+    attr_accessor :is_required
+
+    attr_accessor :is_custom
+
+    attr_accessor :field_choices
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'display_name' => :'display_name',
+        :'description' => :'description',
+        :'is_required' => :'is_required',
+        :'is_custom' => :'is_custom',
+        :'field_choices' => :'field_choices'
+      }
+    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',
+        :'display_name' => :'String',
+        :'description' => :'String',
+        :'is_required' => :'Boolean',
+        :'is_custom' => :'Boolean',
+        :'field_choices' => :'Array<Object>'
+      }
+    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::AdvancedMetadata` 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::AdvancedMetadata`. 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?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'is_required')
+        self.is_required = attributes[:'is_required']
+      end
+
+      if attributes.key?(:'is_custom')
+        self.is_custom = attributes[:'is_custom']
+      end
+
+      if attributes.key?(:'field_choices')
+        if (value = attributes[:'field_choices']).is_a?(Array)
+          self.field_choices = 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
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id 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 @id.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 &&
+          id == o.id &&
+          display_name == o.display_name &&
+          description == o.description &&
+          is_required == o.is_required &&
+          is_custom == o.is_custom &&
+          field_choices == o.field_choices
+    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, display_name, description, is_required, is_custom, field_choices].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/async_passthrough_reciept.rb

@@ -0,0 +1,223 @@
+=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 AsyncPassthroughReciept
+    attr_accessor :async_passthrough_receipt_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'async_passthrough_receipt_id' => :'async_passthrough_receipt_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
+      {
+        :'async_passthrough_receipt_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::AsyncPassthroughReciept` 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::AsyncPassthroughReciept`. 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?(:'async_passthrough_receipt_id')
+        self.async_passthrough_receipt_id = attributes[:'async_passthrough_receipt_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 @async_passthrough_receipt_id.nil?
+        invalid_properties.push('invalid value for "async_passthrough_receipt_id", async_passthrough_receipt_id 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 @async_passthrough_receipt_id.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 &&
+          async_passthrough_receipt_id == o.async_passthrough_receipt_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
+      [async_passthrough_receipt_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