merge_ats_client 3.0.0 → 3.0.2

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/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
 

data/lib/merge_ats_client/models/meta_response.rb

@@ -17,6 +17,8 @@ module MergeATSClient
   class MetaResponse
     attr_accessor :request_schema
 
+    attr_accessor :remote_field_classes
+
     attr_accessor :status
 
     attr_accessor :has_conditional_params
@@ -27,6 +29,7 @@ module MergeATSClient
     def self.attribute_map
       {
         :'request_schema' => :'request_schema',
+        :'remote_field_classes' => :'remote_field_classes',
         :'status' => :'status',
         :'has_conditional_params' => :'has_conditional_params',
         :'has_required_linked_account_params' => :'has_required_linked_account_params'
@@ -42,6 +45,7 @@ module MergeATSClient
     def self.openapi_types
       {
         :'request_schema' => :'Hash<String, Object>',
+        :'remote_field_classes' => :'Hash<String, Object>',
         :'status' => :'LinkedAccountStatus',
         :'has_conditional_params' => :'Boolean',
         :'has_required_linked_account_params' => :'Boolean'
@@ -75,6 +79,12 @@ module MergeATSClient
         end
       end
 
+      if attributes.key?(:'remote_field_classes')
+        if (value = attributes[:'remote_field_classes']).is_a?(Hash)
+          self.remote_field_classes = value
+        end
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -122,6 +132,7 @@ module MergeATSClient
       return true if self.equal?(o)
       self.class == o.class &&
           request_schema == o.request_schema &&
+          remote_field_classes == o.remote_field_classes &&
           status == o.status &&
           has_conditional_params == o.has_conditional_params &&
           has_required_linked_account_params == o.has_required_linked_account_params
@@ -136,7 +147,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [request_schema, status, has_conditional_params, has_required_linked_account_params].hash
+      [request_schema, remote_field_classes, status, has_conditional_params, has_required_linked_account_params].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/multipart_form_field_request.rb

@@ -22,7 +22,7 @@ module MergeATSClient
     # The data for the form field.
     attr_accessor :data
 
-    # The encoding of the value of `data`. Defaults to `RAW` if not defined.
+    # The encoding of the value of `data`. Defaults to `RAW` if not defined.  * `RAW` - RAW * `BASE64` - BASE64 * `GZIP_BASE64` - GZIP_BASE64
     attr_accessor :encoding
 
     # The file name of the form field, if the field is for a file.

data/lib/merge_ats_client/models/offer.rb

@@ -14,15 +14,17 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Offer Object ### Description The `Offer` object is used to represent an offer for an application. ### Usage Example Fetch from the `LIST Offers` endpoint and filter by `ID` to show all offers.
+  # # The Offer Object ### Description The `Offer` object is used to represent an offer for a candidate's application specific to a job. ### Usage Example Fetch from the `LIST Offers` endpoint and filter by `ID` to show all offers.
   class Offer
     attr_accessor :id
 
     # The third-party API ID of the matching object.
     attr_accessor :remote_id
 
+    # The application who is receiving the offer.
     attr_accessor :application
 
+    # The user who created the offer.
     attr_accessor :creator
 
     # When the third party's offer was created.
@@ -37,14 +39,19 @@ module MergeATSClient
     # The employment start date on the offer.
     attr_accessor :start_date
 
-    # The offer's status.
+    # The offer's status.  * `DRAFT` - DRAFT * `APPROVAL-SENT` - APPROVAL-SENT * `APPROVED` - APPROVED * `SENT` - SENT * `SENT-MANUALLY` - SENT-MANUALLY * `OPENED` - OPENED * `DENIED` - DENIED * `SIGNED` - SIGNED * `DEPRECATED` - DEPRECATED
     attr_accessor :status
 
-    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
       {
@@ -57,8 +64,10 @@ module MergeATSClient
         :'sent_at' => :'sent_at',
         :'start_date' => :'start_date',
         :'status' => :'status',
-        :'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
 
@@ -79,8 +88,10 @@ module MergeATSClient
         :'sent_at' => :'Time',
         :'start_date' => :'Time',
         :'status' => :'OfferStatusEnum',
-        :'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
 
@@ -95,7 +106,8 @@ module MergeATSClient
         :'sent_at',
         :'start_date',
         :'status',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -150,15 +162,25 @@ module MergeATSClient
         self.status = attributes[:'status']
       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?
@@ -188,8 +210,10 @@ module MergeATSClient
           sent_at == o.sent_at &&
           start_date == o.start_date &&
           status == o.status &&
-          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
@@ -201,7 +225,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, application, creator, remote_created_at, closed_at, sent_at, start_date, status, remote_data, remote_was_deleted].hash
+      [id, remote_id, application, creator, remote_created_at, closed_at, sent_at, start_date, status, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/office.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Office Object ### Description The `Office` object is used to represent an office within a company. ### Usage Example Fetch from the `LIST Offices` endpoint and view the offices within a company.
+  # # The Office Object ### Description The `Office` object is used to represent an office within a company. A given `Job` has the `Office` ID in its offices field. ### Usage Example Fetch from the `LIST Offices` endpoint and view the offices within a company.
   class Office
     attr_accessor :id
 
@@ -27,11 +27,16 @@ module MergeATSClient
     # The office's location.
     attr_accessor :location
 
-    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
       {
@@ -39,8 +44,10 @@ module MergeATSClient
         :'remote_id' => :'remote_id',
         :'name' => :'name',
         :'location' => :'location',
-        :'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
 
@@ -56,8 +63,10 @@ module MergeATSClient
         :'remote_id' => :'String',
         :'name' => :'String',
         :'location' => :'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
 
@@ -67,7 +76,8 @@ module MergeATSClient
         :'remote_id',
         :'name',
         :'location',
-        :'remote_data',
+        :'field_mappings',
+        :'remote_data'
       ])
     end
 
@@ -102,15 +112,25 @@ module MergeATSClient
         self.location = attributes[:'location']
       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?
@@ -135,8 +155,10 @@ module MergeATSClient
           remote_id == o.remote_id &&
           name == o.name &&
           location == o.location &&
-          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
@@ -148,7 +170,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, name, location, remote_data, remote_was_deleted].hash
+      [id, remote_id, name, location, remote_was_deleted, field_mappings, modified_at, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/phone_number.rb

@@ -19,14 +19,18 @@ module MergeATSClient
     # The phone number.
     attr_accessor :value
 
-    # The type of phone number.
+    # The type of phone number.  * `HOME` - HOME * `WORK` - WORK * `MOBILE` - MOBILE * `SKYPE` - SKYPE * `OTHER` - OTHER
     attr_accessor :phone_number_type
 
+    # This is the datetime that this object was last updated by Merge
+    attr_accessor :modified_at
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'value' => :'value',
-        :'phone_number_type' => :'phone_number_type'
+        :'phone_number_type' => :'phone_number_type',
+        :'modified_at' => :'modified_at'
       }
     end
 
@@ -39,7 +43,8 @@ module MergeATSClient
     def self.openapi_types
       {
         :'value' => :'String',
-        :'phone_number_type' => :'PhoneNumberTypeEnum'
+        :'phone_number_type' => :'PhoneNumberTypeEnum',
+        :'modified_at' => :'Time'
       }
     end
 
@@ -47,7 +52,7 @@ module MergeATSClient
     def self.openapi_nullable
       Set.new([
         :'value',
-        :'phone_number_type'
+        :'phone_number_type',
       ])
     end
 
@@ -73,6 +78,10 @@ module MergeATSClient
       if attributes.key?(:'phone_number_type')
         self.phone_number_type = attributes[:'phone_number_type']
       end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,7 +103,8 @@ module MergeATSClient
       return true if self.equal?(o)
       self.class == o.class &&
           value == o.value &&
-          phone_number_type == o.phone_number_type
+          phone_number_type == o.phone_number_type &&
+          modified_at == o.modified_at
     end
 
     # @see the `==` method
@@ -106,7 +116,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [value, phone_number_type].hash
+      [value, phone_number_type, modified_at].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/phone_number_request.rb

@@ -19,7 +19,7 @@ module MergeATSClient
     # The phone number.
     attr_accessor :value
 
-    # The type of phone number.
+    # The type of phone number.  * `HOME` - HOME * `WORK` - WORK * `MOBILE` - MOBILE * `SKYPE` - SKYPE * `OTHER` - OTHER
     attr_accessor :phone_number_type
 
     attr_accessor :integration_params