merge_ats_client 2.0.1 → 3.0.1

data/lib/merge_ats_client/models/account_integration.rb

@@ -18,7 +18,7 @@ module MergeATSClient
     # 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 MergeATSClient
 
     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 MergeATSClient
         :'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 MergeATSClient
         :'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 MergeATSClient
       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 MergeATSClient
       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 MergeATSClient
     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 MergeATSClient
       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 MergeATSClient
           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 MergeATSClient
     # 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_ats_client/models/activity.rb

@@ -14,19 +14,20 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Activity Object ### Description The `Activity` object is used to represent an activity performed by a user. ### Usage Example Fetch from the `LIST Activities` endpoint and filter by `ID` to show all activities.
+  # # The Activity Object ### Description The `Activity` object is used to represent an activity for a candidate performed by a user. ### Usage Example Fetch from the `LIST Activities` endpoint and filter by `ID` to show all activities.
   class Activity
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
+    # The user that performed the action.
     attr_accessor :user
 
     # When the third party's activity was created.
     attr_accessor :remote_created_at
 
-    # The activity's type.
+    # The activity's type.  * `NOTE` - NOTE * `EMAIL` - EMAIL * `OTHER` - OTHER
     attr_accessor :activity_type
 
     # The activity's subject.
@@ -35,14 +36,22 @@ module MergeATSClient
     # The activity's body.
     attr_accessor :body
 
-    # The activity's visibility.
+    # The activity's visibility.  * `ADMIN_ONLY` - ADMIN_ONLY * `PUBLIC` - PUBLIC * `PRIVATE` - PRIVATE
     attr_accessor :visibility
 
-    attr_accessor :remote_data
+    # The activity’s candidate.
+    attr_accessor :candidate
 
     # 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 +63,11 @@ module MergeATSClient
         :'subject' => :'subject',
         :'body' => :'body',
         :'visibility' => :'visibility',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'candidate' => :'candidate',
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -75,8 +87,11 @@ module MergeATSClient
         :'subject' => :'String',
         :'body' => :'String',
         :'visibility' => :'VisibilityEnum',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'candidate' => :'String',
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -90,7 +105,9 @@ module MergeATSClient
         :'subject',
         :'body',
         :'visibility',
-        :'remote_data',
+        :'candidate',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -141,15 +158,29 @@ module MergeATSClient
         self.visibility = attributes[:'visibility']
       end
 
-      if attributes.key?(:'remote_data')
-        if (value = attributes[:'remote_data']).is_a?(Array)
-          self.remote_data = value
-        end
+      if attributes.key?(:'candidate')
+        self.candidate = attributes[:'candidate']
       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
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -178,8 +209,11 @@ module MergeATSClient
           subject == o.subject &&
           body == o.body &&
           visibility == o.visibility &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          candidate == o.candidate &&
+          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
@@ -191,7 +225,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, user, remote_created_at, activity_type, subject, body, visibility, remote_data, remote_was_deleted].hash
+      [id, remote_id, user, remote_created_at, activity_type, subject, body, visibility, candidate, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/activity_endpoint_request.rb

@@ -0,0 +1,237 @@
+=begin
+#Merge ATS API
+
+#The unified API for building rich integrations with multiple Applicant Tracking 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 MergeATSClient
+  class ActivityEndpointRequest
+    attr_accessor :model
+
+    attr_accessor :remote_user_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'model' => :'model',
+        :'remote_user_id' => :'remote_user_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
+      {
+        :'model' => :'ActivityRequest',
+        :'remote_user_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 `MergeATSClient::ActivityEndpointRequest` 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 `MergeATSClient::ActivityEndpointRequest`. 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?(:'model')
+        self.model = attributes[:'model']
+      end
+
+      if attributes.key?(:'remote_user_id')
+        self.remote_user_id = attributes[:'remote_user_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 @model.nil?
+        invalid_properties.push('invalid value for "model", model cannot be nil.')
+      end
+
+      if @remote_user_id.nil?
+        invalid_properties.push('invalid value for "remote_user_id", remote_user_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 @model.nil?
+      return false if @remote_user_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 &&
+          model == o.model &&
+          remote_user_id == o.remote_user_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
+      [model, remote_user_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 = MergeATSClient.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