merge_ats_client 2.0.1 → 3.0.1

data/lib/merge_ats_client/models/email_address_request.rb

@@ -19,14 +19,20 @@ module MergeATSClient
     # The email address.
     attr_accessor :value
 
-    # The type of email address.
+    # The type of email address.  * `PERSONAL` - PERSONAL * `WORK` - WORK * `OTHER` - OTHER
     attr_accessor :email_address_type
 
+    attr_accessor :integration_params
+
+    attr_accessor :linked_account_params
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'value' => :'value',
-        :'email_address_type' => :'email_address_type'
+        :'email_address_type' => :'email_address_type',
+        :'integration_params' => :'integration_params',
+        :'linked_account_params' => :'linked_account_params'
       }
     end
 
@@ -39,7 +45,9 @@ module MergeATSClient
     def self.openapi_types
       {
         :'value' => :'String',
-        :'email_address_type' => :'EmailAddressTypeEnum'
+        :'email_address_type' => :'EmailAddressTypeEnum',
+        :'integration_params' => :'Hash<String, Object>',
+        :'linked_account_params' => :'Hash<String, Object>'
       }
     end
 
@@ -47,7 +55,9 @@ module MergeATSClient
     def self.openapi_nullable
       Set.new([
         :'value',
-        :'email_address_type'
+        :'email_address_type',
+        :'integration_params',
+        :'linked_account_params'
       ])
     end
 
@@ -73,6 +83,18 @@ module MergeATSClient
       if attributes.key?(:'email_address_type')
         self.email_address_type = attributes[:'email_address_type']
       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?
@@ -109,7 +131,9 @@ module MergeATSClient
       return true if self.equal?(o)
       self.class == o.class &&
           value == o.value &&
-          email_address_type == o.email_address_type
+          email_address_type == o.email_address_type &&
+          integration_params == o.integration_params &&
+          linked_account_params == o.linked_account_params
     end
 
     # @see the `==` method
@@ -121,7 +145,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [value, email_address_type].hash
+      [value, email_address_type, integration_params, linked_account_params].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/email_address_type_enum.rb

@@ -39,7 +39,7 @@ module MergeATSClient
     end
 
     def self.build_from_hash(value)
-      IssueStatusEnum.new.build_from_hash(value)
+      EmailAddressTypeEnum.new.build_from_hash(value)
     end
   end
 

data/lib/merge_ats_client/models/enabled_actions_enum.rb

@@ -0,0 +1,45 @@
+=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 EnabledActionsEnum
+    READ = "READ".freeze
+    WRITE = "WRITE".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 ["READ", "WRITE", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      EnabledActionsEnum.new.build_from_hash(value)
+    end
+  end
+
+end

data/lib/merge_ats_client/models/encoding_enum.rb

@@ -39,7 +39,7 @@ module MergeATSClient
     end
 
     def self.build_from_hash(value)
-      IssueStatusEnum.new.build_from_hash(value)
+      EncodingEnum.new.build_from_hash(value)
     end
   end
 

data/lib/merge_ats_client/models/end_user_details_request.rb

@@ -15,13 +15,13 @@ require 'time'
 
 module MergeATSClient
   class EndUserDetailsRequest
-    # Your end user's email address.
+    # Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
     attr_accessor :end_user_email_address
 
     # Your end user's organization.
     attr_accessor :end_user_organization_name
 
-    # Unique ID for your end user.
+    # This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
     attr_accessor :end_user_origin_id
 
     # The integration categories to show in Merge Link.
@@ -36,6 +36,9 @@ module MergeATSClient
     # Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/.
     attr_accessor :should_create_magic_link_url
 
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,7 +48,8 @@ module MergeATSClient
         :'categories' => :'categories',
         :'integration' => :'integration',
         :'link_expiry_mins' => :'link_expiry_mins',
-        :'should_create_magic_link_url' => :'should_create_magic_link_url'
+        :'should_create_magic_link_url' => :'should_create_magic_link_url',
+        :'common_models' => :'common_models'
       }
     end
 
@@ -63,7 +67,8 @@ module MergeATSClient
         :'categories' => :'Array<CategoriesEnum>',
         :'integration' => :'String',
         :'link_expiry_mins' => :'Integer',
-        :'should_create_magic_link_url' => :'Boolean'
+        :'should_create_magic_link_url' => :'Boolean',
+        :'common_models' => :'Array<CommonModelScopesBodyRequest>'
       }
     end
 
@@ -71,7 +76,8 @@ module MergeATSClient
     def self.openapi_nullable
       Set.new([
         :'integration',
-        :'should_create_magic_link_url'
+        :'should_create_magic_link_url',
+        :'common_models'
       ])
     end
 
@@ -123,6 +129,12 @@ module MergeATSClient
       else
         self.should_create_magic_link_url = false
       end
+
+      if attributes.key?(:'common_models')
+        if (value = attributes[:'common_models']).is_a?(Array)
+          self.common_models = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -292,7 +304,8 @@ module MergeATSClient
           categories == o.categories &&
           integration == o.integration &&
           link_expiry_mins == o.link_expiry_mins &&
-          should_create_magic_link_url == o.should_create_magic_link_url
+          should_create_magic_link_url == o.should_create_magic_link_url &&
+          common_models == o.common_models
     end
 
     # @see the `==` method
@@ -304,7 +317,7 @@ module MergeATSClient
     # 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].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
 
     # Builds the object from hash

data/lib/merge_ats_client/models/gender_enum.rb

@@ -41,7 +41,7 @@ module MergeATSClient
     end
 
     def self.build_from_hash(value)
-      IssueStatusEnum.new.build_from_hash(value)
+      GenderEnum.new.build_from_hash(value)
     end
   end
 

data/lib/merge_ats_client/models/issue.rb

@@ -17,6 +17,7 @@ module MergeATSClient
   class Issue
     attr_accessor :id
 
+    # Status of the issue. Options: ('ONGOING', 'RESOLVED')  * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
     attr_accessor :status
 
     attr_accessor :error_description
@@ -29,6 +30,8 @@ module MergeATSClient
 
     attr_accessor :is_muted
 
+    attr_accessor :error_details
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +41,8 @@ module MergeATSClient
         :'end_user' => :'end_user',
         :'first_incident_time' => :'first_incident_time',
         :'last_incident_time' => :'last_incident_time',
-        :'is_muted' => :'is_muted'
+        :'is_muted' => :'is_muted',
+        :'error_details' => :'error_details'
       }
     end
 
@@ -56,7 +60,8 @@ module MergeATSClient
         :'end_user' => :'Hash<String, Object>',
         :'first_incident_time' => :'Time',
         :'last_incident_time' => :'Time',
-        :'is_muted' => :'Boolean'
+        :'is_muted' => :'Boolean',
+        :'error_details' => :'Array<String>'
       }
     end
 
@@ -112,6 +117,12 @@ module MergeATSClient
       if attributes.key?(:'is_muted')
         self.is_muted = attributes[:'is_muted']
       end
+
+      if attributes.key?(:'error_details')
+        if (value = attributes[:'error_details']).is_a?(Array)
+          self.error_details = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -143,7 +154,8 @@ module MergeATSClient
           end_user == o.end_user &&
           first_incident_time == o.first_incident_time &&
           last_incident_time == o.last_incident_time &&
-          is_muted == o.is_muted
+          is_muted == o.is_muted &&
+          error_details == o.error_details
     end
 
     # @see the `==` method
@@ -155,7 +167,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, status, error_description, end_user, first_incident_time, last_incident_time, is_muted].hash
+      [id, status, error_description, end_user, first_incident_time, last_incident_time, is_muted, error_details].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/job.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Job Object ### Description The `Job` object is used to represent a Job offering at a company. ### Usage Example Fetch from the `LIST Jobs` endpoint to show all job postings.
+  # # The Job Object ### Description The `Job` object can be used to track any jobs that are currently or will be open/closed for applications. ### Usage Example Fetch from the `LIST Jobs` endpoint to show all job postings.
   class Job
     attr_accessor :id
 
@@ -30,7 +30,7 @@ module MergeATSClient
     # The job's code. Typically an additional identifier used to reference the particular job that is displayed on the ATS.
     attr_accessor :code
 
-    # The job's status.
+    # The job's status.  * `OPEN` - OPEN * `CLOSED` - CLOSED * `DRAFT` - DRAFT * `ARCHIVED` - ARCHIVED * `PENDING` - PENDING
     attr_accessor :status
 
     attr_accessor :job_posting_urls
@@ -56,11 +56,16 @@ module MergeATSClient
     # IDs of `RemoteUser` objects that serve as recruiters for this `Job`.
     attr_accessor :recruiters
 
-    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
       {
@@ -78,8 +83,10 @@ module MergeATSClient
         :'offices' => :'offices',
         :'hiring_managers' => :'hiring_managers',
         :'recruiters' => :'recruiters',
-        :'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
 
@@ -105,8 +112,10 @@ module MergeATSClient
         :'offices' => :'Array<String>',
         :'hiring_managers' => :'Array<String>',
         :'recruiters' => :'Array<String>',
-        :'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
 
@@ -121,7 +130,8 @@ module MergeATSClient
         :'remote_created_at',
         :'remote_updated_at',
         :'confidential',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -206,15 +216,25 @@ module MergeATSClient
         end
       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?
@@ -249,8 +269,10 @@ module MergeATSClient
           offices == o.offices &&
           hiring_managers == o.hiring_managers &&
           recruiters == o.recruiters &&
-          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
@@ -262,7 +284,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, name, description, code, status, job_posting_urls, remote_created_at, remote_updated_at, confidential, departments, offices, hiring_managers, recruiters, remote_data, remote_was_deleted].hash
+      [id, remote_id, name, description, code, status, job_posting_urls, remote_created_at, remote_updated_at, confidential, departments, offices, hiring_managers, recruiters, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/job_interview_stage.rb

@@ -14,24 +14,32 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The JobInterviewStage Object ### Description The `JobInterviewStage` object is used to represent the stage that a job application is in. ### Usage Example Fetch from the `LIST JobInterviewStages` endpoint and view the job interview stages used by a company.
+  # # The JobInterviewStage Object ### Description The `JobInterviewStage` object is used to represent a particular recruiting stage for an `Application`. A given `Application` typically has the `JobInterviewStage` object represented in the current_stage field. ### Usage Example Fetch from the `LIST JobInterviewStages` endpoint and view the job interview stages used by a company.
   class JobInterviewStage
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
-    # The stage's name.
+    # Standard stage names are offered by ATS systems but can be modified by users.
     attr_accessor :name
 
     # This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated.
     attr_accessor :job
 
-    attr_accessor :remote_data
+    # The stage’s order, with the lowest values ordered first. If the third-party does not return details on the order of stages, this field will not be populated.
+    attr_accessor :stage_order
 
     # 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
       {
@@ -39,8 +47,11 @@ module MergeATSClient
         :'remote_id' => :'remote_id',
         :'name' => :'name',
         :'job' => :'job',
-        :'remote_data' => :'remote_data',
-        :'remote_was_deleted' => :'remote_was_deleted'
+        :'stage_order' => :'stage_order',
+        :'remote_was_deleted' => :'remote_was_deleted',
+        :'field_mappings' => :'field_mappings',
+        :'modified_at' => :'modified_at',
+        :'remote_data' => :'remote_data'
       }
     end
 
@@ -56,8 +67,11 @@ module MergeATSClient
         :'remote_id' => :'String',
         :'name' => :'String',
         :'job' => :'String',
-        :'remote_data' => :'Array<RemoteData>',
-        :'remote_was_deleted' => :'Boolean'
+        :'stage_order' => :'Integer',
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -67,7 +81,9 @@ module MergeATSClient
         :'remote_id',
         :'name',
         :'job',
-        :'remote_data',
+        :'stage_order',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -102,30 +118,68 @@ module MergeATSClient
         self.job = attributes[:'job']
       end
 
-      if attributes.key?(:'remote_data')
-        if (value = attributes[:'remote_data']).is_a?(Array)
-          self.remote_data = value
-        end
+      if attributes.key?(:'stage_order')
+        self.stage_order = attributes[:'stage_order']
       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?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@stage_order.nil? && @stage_order > 2147483647
+        invalid_properties.push('invalid value for "stage_order", must be smaller than or equal to 2147483647.')
+      end
+
+      if !@stage_order.nil? && @stage_order < -2147483648
+        invalid_properties.push('invalid value for "stage_order", must be greater than or equal to -2147483648.')
+      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 !@stage_order.nil? && @stage_order > 2147483647
+      return false if !@stage_order.nil? && @stage_order < -2147483648
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] stage_order Value to be assigned
+    def stage_order=(stage_order)
+      if !stage_order.nil? && stage_order > 2147483647
+        fail ArgumentError, 'invalid value for "stage_order", must be smaller than or equal to 2147483647.'
+      end
+
+      if !stage_order.nil? && stage_order < -2147483648
+        fail ArgumentError, 'invalid value for "stage_order", must be greater than or equal to -2147483648.'
+      end
+
+      @stage_order = stage_order
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -135,8 +189,11 @@ module MergeATSClient
           remote_id == o.remote_id &&
           name == o.name &&
           job == o.job &&
-          remote_data == o.remote_data &&
-          remote_was_deleted == o.remote_was_deleted
+          stage_order == o.stage_order &&
+          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
@@ -148,7 +205,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, name, job, remote_data, remote_was_deleted].hash
+      [id, remote_id, name, job, stage_order, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/job_status_enum.rb

@@ -41,7 +41,7 @@ module MergeATSClient
     end
 
     def self.build_from_hash(value)
-      IssueStatusEnum.new.build_from_hash(value)
+      JobStatusEnum.new.build_from_hash(value)
     end
   end
 

data/lib/merge_ats_client/models/link_token.rb

@@ -86,10 +86,6 @@ module MergeATSClient
         invalid_properties.push('invalid value for "link_token", link_token cannot be nil.')
       end
 
-      if @integration_name.nil?
-        invalid_properties.push('invalid value for "integration_name", integration_name cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -97,7 +93,6 @@ module MergeATSClient
     # @return true if the model is valid
     def valid?
       return false if @link_token.nil?
-      return false if @integration_name.nil?
       true
     end