merge_ats_client 2.0.1 → 3.0.1

data/lib/merge_ats_client/models/application.rb

@@ -14,15 +14,17 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Application Object ### Description The `Application` object is used to represent an Application for a job position. This is separate from the Candidate object, although some systems may only allow a Candidate to have one Application.  Please note: Application objects are constructed if the object does not exist in the remote system.  ### Usage Example Fetch from the `LIST Applications` endpoint and filter by `ID` to show all applications.
+  # # The Application Object ### Description The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.  ### Usage Example Fetch from the `LIST Applications` endpoint and filter by `ID` to show all applications.
   class Application
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
+    # The candidate applying.
     attr_accessor :candidate
 
+    # The job being applied for.
     attr_accessor :job
 
     # When the application was submitted.
@@ -34,18 +36,23 @@ module MergeATSClient
     # The application's source.
     attr_accessor :source
 
+    # The user credited for this application.
     attr_accessor :credited_to
 
+    # The application's current stage.
     attr_accessor :current_stage
 
+    # The application's reason for rejection.
     attr_accessor :reject_reason
 
-    attr_accessor :remote_data
+    attr_accessor :remote_was_deleted
 
-    # Custom fields configured for a given model.
-    attr_accessor :custom_fields
+    attr_accessor :field_mappings
 
-    attr_accessor :remote_was_deleted
+    # 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
@@ -60,9 +67,10 @@ module MergeATSClient
         :'credited_to' => :'credited_to',
         :'current_stage' => :'current_stage',
         :'reject_reason' => :'reject_reason',
-        :'remote_data' => :'remote_data',
-        :'custom_fields' => :'custom_fields',
-        :'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
 
@@ -84,9 +92,10 @@ module MergeATSClient
         :'credited_to' => :'String',
         :'current_stage' => :'String',
         :'reject_reason' => :'String',
-        :'remote_data' => :'Array<RemoteData>',
-        :'custom_fields' => :'Hash<String, Object>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -102,8 +111,8 @@ module MergeATSClient
         :'credited_to',
         :'current_stage',
         :'reject_reason',
-        :'remote_data',
-        :'custom_fields',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -162,20 +171,24 @@ module MergeATSClient
         self.reject_reason = attributes[:'reject_reason']
       end
 
-      if attributes.key?(:'remote_data')
-        if (value = attributes[:'remote_data']).is_a?(Array)
-          self.remote_data = value
-        end
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
 
-      if attributes.key?(:'custom_fields')
-        if (value = attributes[:'custom_fields']).is_a?(Hash)
-          self.custom_fields = value
+      if attributes.key?(:'field_mappings')
+        if (value = attributes[:'field_mappings']).is_a?(Hash)
+          self.field_mappings = value
         end
       end
 
-      if attributes.key?(:'remote_was_deleted')
-        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      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
 
@@ -207,9 +220,10 @@ module MergeATSClient
           credited_to == o.credited_to &&
           current_stage == o.current_stage &&
           reject_reason == o.reject_reason &&
-          remote_data == o.remote_data &&
-          custom_fields == o.custom_fields &&
-          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
@@ -221,7 +235,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, candidate, job, applied_at, rejected_at, source, credited_to, current_stage, reject_reason, remote_data, custom_fields, remote_was_deleted].hash
+      [id, remote_id, candidate, job, applied_at, rejected_at, source, credited_to, current_stage, reject_reason, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/application_request.rb

@@ -14,13 +14,12 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Application Object ### Description The `Application` object is used to represent an Application for a job position. This is separate from the Candidate object, although some systems may only allow a Candidate to have one Application.  Please note: Application objects are constructed if the object does not exist in the remote system.  ### Usage Example Fetch from the `LIST Applications` endpoint and filter by `ID` to show all applications.
+  # # The Application Object ### Description The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.  ### Usage Example Fetch from the `LIST Applications` endpoint and filter by `ID` to show all applications.
   class ApplicationRequest
-    # The third-party API ID of the matching object.
-    attr_accessor :remote_id
-
+    # The candidate applying.
     attr_accessor :candidate
 
+    # The job being applied for.
     attr_accessor :job
 
     # When the application was submitted.
@@ -32,15 +31,15 @@ module MergeATSClient
     # The application's source.
     attr_accessor :source
 
+    # The user credited for this application.
     attr_accessor :credited_to
 
+    # The application's current stage.
     attr_accessor :current_stage
 
+    # The application's reason for rejection.
     attr_accessor :reject_reason
 
-    # Custom fields configured for a given model.
-    attr_accessor :custom_fields
-
     attr_accessor :remote_template_id
 
     attr_accessor :integration_params
@@ -50,7 +49,6 @@ module MergeATSClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'remote_id' => :'remote_id',
         :'candidate' => :'candidate',
         :'job' => :'job',
         :'applied_at' => :'applied_at',
@@ -59,7 +57,6 @@ module MergeATSClient
         :'credited_to' => :'credited_to',
         :'current_stage' => :'current_stage',
         :'reject_reason' => :'reject_reason',
-        :'custom_fields' => :'custom_fields',
         :'remote_template_id' => :'remote_template_id',
         :'integration_params' => :'integration_params',
         :'linked_account_params' => :'linked_account_params'
@@ -74,7 +71,6 @@ module MergeATSClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'remote_id' => :'String',
         :'candidate' => :'String',
         :'job' => :'String',
         :'applied_at' => :'Time',
@@ -83,7 +79,6 @@ module MergeATSClient
         :'credited_to' => :'String',
         :'current_stage' => :'String',
         :'reject_reason' => :'String',
-        :'custom_fields' => :'Hash<String, Object>',
         :'remote_template_id' => :'String',
         :'integration_params' => :'Hash<String, Object>',
         :'linked_account_params' => :'Hash<String, Object>'
@@ -93,7 +88,6 @@ module MergeATSClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'remote_id',
         :'candidate',
         :'job',
         :'applied_at',
@@ -102,7 +96,6 @@ module MergeATSClient
         :'credited_to',
         :'current_stage',
         :'reject_reason',
-        :'custom_fields',
         :'remote_template_id',
         :'integration_params',
         :'linked_account_params'
@@ -124,10 +117,6 @@ module MergeATSClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'remote_id')
-        self.remote_id = attributes[:'remote_id']
-      end
-
       if attributes.key?(:'candidate')
         self.candidate = attributes[:'candidate']
       end
@@ -160,12 +149,6 @@ module MergeATSClient
         self.reject_reason = attributes[:'reject_reason']
       end
 
-      if attributes.key?(:'custom_fields')
-        if (value = attributes[:'custom_fields']).is_a?(Hash)
-          self.custom_fields = value
-        end
-      end
-
       if attributes.key?(:'remote_template_id')
         self.remote_template_id = attributes[:'remote_template_id']
       end
@@ -216,7 +199,6 @@ module MergeATSClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          remote_id == o.remote_id &&
           candidate == o.candidate &&
           job == o.job &&
           applied_at == o.applied_at &&
@@ -225,7 +207,6 @@ module MergeATSClient
           credited_to == o.credited_to &&
           current_stage == o.current_stage &&
           reject_reason == o.reject_reason &&
-          custom_fields == o.custom_fields &&
           remote_template_id == o.remote_template_id &&
           integration_params == o.integration_params &&
           linked_account_params == o.linked_account_params
@@ -240,7 +221,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [remote_id, candidate, job, applied_at, rejected_at, source, credited_to, current_stage, reject_reason, custom_fields, remote_template_id, integration_params, linked_account_params].hash
+      [candidate, job, applied_at, rejected_at, source, credited_to, current_stage, reject_reason, remote_template_id, integration_params, linked_account_params].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/attachment.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Attachment Object ### Description The `Attachment` object is used to represent a attachment for a candidate. ### Usage Example Fetch from the `LIST Attachments` endpoint and view attachments accessible by a company.
+  # # The Attachment Object ### Description The `Attachment` object is used to represent a file attached to a candidate. ### Usage Example Fetch from the `LIST Attachments` endpoint and view attachments accessible by a company.
   class Attachment
     attr_accessor :id
 
@@ -29,13 +29,18 @@ module MergeATSClient
 
     attr_accessor :candidate
 
-    # The attachment's type.
+    # The attachment's type.  * `RESUME` - RESUME * `COVER_LETTER` - COVER_LETTER * `OFFER_LETTER` - OFFER_LETTER * `OTHER` - OTHER
     attr_accessor :attachment_type
 
-    attr_accessor :remote_data
-
     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
       {
@@ -45,8 +50,10 @@ module MergeATSClient
         :'file_url' => :'file_url',
         :'candidate' => :'candidate',
         :'attachment_type' => :'attachment_type',
-        :'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
 
@@ -64,8 +71,10 @@ module MergeATSClient
         :'file_url' => :'String',
         :'candidate' => :'String',
         :'attachment_type' => :'AttachmentTypeEnum',
-        :'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
 
@@ -77,7 +86,8 @@ module MergeATSClient
         :'file_url',
         :'candidate',
         :'attachment_type',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -120,15 +130,25 @@ module MergeATSClient
         self.attachment_type = attributes[:'attachment_type']
       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?
@@ -170,8 +190,10 @@ module MergeATSClient
           file_url == o.file_url &&
           candidate == o.candidate &&
           attachment_type == o.attachment_type &&
-          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
@@ -183,7 +205,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, file_name, file_url, candidate, attachment_type, remote_data, remote_was_deleted].hash
+      [id, remote_id, file_name, file_url, candidate, attachment_type, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/attachment_request.rb

@@ -14,11 +14,8 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Attachment Object ### Description The `Attachment` object is used to represent a attachment for a candidate. ### Usage Example Fetch from the `LIST Attachments` endpoint and view attachments accessible by a company.
+  # # The Attachment Object ### Description The `Attachment` object is used to represent a file attached to a candidate. ### Usage Example Fetch from the `LIST Attachments` endpoint and view attachments accessible by a company.
   class AttachmentRequest
-    # The third-party API ID of the matching object.
-    attr_accessor :remote_id
-
     # The attachment's name.
     attr_accessor :file_name
 
@@ -27,7 +24,7 @@ module MergeATSClient
 
     attr_accessor :candidate
 
-    # The attachment's type.
+    # The attachment's type.  * `RESUME` - RESUME * `COVER_LETTER` - COVER_LETTER * `OFFER_LETTER` - OFFER_LETTER * `OTHER` - OTHER
     attr_accessor :attachment_type
 
     attr_accessor :integration_params
@@ -37,7 +34,6 @@ module MergeATSClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'remote_id' => :'remote_id',
         :'file_name' => :'file_name',
         :'file_url' => :'file_url',
         :'candidate' => :'candidate',
@@ -55,7 +51,6 @@ module MergeATSClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'remote_id' => :'String',
         :'file_name' => :'String',
         :'file_url' => :'String',
         :'candidate' => :'String',
@@ -68,7 +63,6 @@ module MergeATSClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'remote_id',
         :'file_name',
         :'file_url',
         :'candidate',
@@ -93,10 +87,6 @@ module MergeATSClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'remote_id')
-        self.remote_id = attributes[:'remote_id']
-      end
-
       if attributes.key?(:'file_name')
         self.file_name = attributes[:'file_name']
       end
@@ -159,7 +149,6 @@ module MergeATSClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          remote_id == o.remote_id &&
           file_name == o.file_name &&
           file_url == o.file_url &&
           candidate == o.candidate &&
@@ -177,7 +166,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [remote_id, file_name, file_url, candidate, attachment_type, integration_params, linked_account_params].hash
+      [file_name, file_url, candidate, attachment_type, integration_params, linked_account_params].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/attachment_type_enum.rb

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

data/lib/merge_ats_client/models/candidate.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Candidate Object ### Description The `Candidate` object is used to represent a Candidate for various positions. ### Usage Example Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates.
+  # # The Candidate Object ### Description The `Candidate` object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications. ### Usage Example Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates.
   class Candidate
     attr_accessor :id
 
@@ -39,7 +39,7 @@ module MergeATSClient
     # When the third party's candidate was updated.
     attr_accessor :remote_updated_at
 
-    # When the most recent candidate interaction occurred.
+    # When the most recent interaction with the candidate occurred.
     attr_accessor :last_interaction_at
 
     # Whether or not the candidate is private.
@@ -66,12 +66,14 @@ module MergeATSClient
     # Array of `Attachment` object IDs.
     attr_accessor :attachments
 
-    attr_accessor :remote_data
+    attr_accessor :remote_was_deleted
 
-    # Custom fields configured for a given model.
-    attr_accessor :custom_fields
+    attr_accessor :field_mappings
 
-    attr_accessor :remote_was_deleted
+    # 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
@@ -94,9 +96,10 @@ module MergeATSClient
         :'tags' => :'tags',
         :'applications' => :'applications',
         :'attachments' => :'attachments',
-        :'remote_data' => :'remote_data',
-        :'custom_fields' => :'custom_fields',
-        :'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
 
@@ -126,9 +129,10 @@ module MergeATSClient
         :'tags' => :'Array<String>',
         :'applications' => :'Array<String>',
         :'attachments' => :'Array<String>',
-        :'remote_data' => :'Array<RemoteData>',
-        :'custom_fields' => :'Hash<String, Object>',
-        :'remote_was_deleted' => :'Boolean'
+        :'remote_was_deleted' => :'Boolean',
+        :'field_mappings' => :'Hash<String, Object>',
+        :'modified_at' => :'Time',
+        :'remote_data' => :'Array<RemoteData>'
       }
     end
 
@@ -146,8 +150,8 @@ module MergeATSClient
         :'is_private',
         :'can_email',
         :'locations',
-        :'remote_data',
-        :'custom_fields',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -252,20 +256,24 @@ module MergeATSClient
         end
       end
 
-      if attributes.key?(:'remote_data')
-        if (value = attributes[:'remote_data']).is_a?(Array)
-          self.remote_data = value
-        end
+      if attributes.key?(:'remote_was_deleted')
+        self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
 
-      if attributes.key?(:'custom_fields')
-        if (value = attributes[:'custom_fields']).is_a?(Hash)
-          self.custom_fields = value
+      if attributes.key?(:'field_mappings')
+        if (value = attributes[:'field_mappings']).is_a?(Hash)
+          self.field_mappings = value
         end
       end
 
-      if attributes.key?(:'remote_was_deleted')
-        self.remote_was_deleted = attributes[:'remote_was_deleted']
+      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
 
@@ -305,9 +313,10 @@ module MergeATSClient
           tags == o.tags &&
           applications == o.applications &&
           attachments == o.attachments &&
-          remote_data == o.remote_data &&
-          custom_fields == o.custom_fields &&
-          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
@@ -319,7 +328,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, first_name, last_name, company, title, remote_created_at, remote_updated_at, last_interaction_at, is_private, can_email, locations, phone_numbers, email_addresses, urls, tags, applications, attachments, remote_data, custom_fields, remote_was_deleted].hash
+      [id, remote_id, first_name, last_name, company, title, remote_created_at, remote_updated_at, last_interaction_at, is_private, can_email, locations, phone_numbers, email_addresses, urls, tags, applications, attachments, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash