merge_ats_client 1.0.4 → 2.0.0

data/lib/merge_ats_client/api/webhook_receivers_api.rb

@@ -0,0 +1,154 @@
+=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 'cgi'
+
+module MergeATSClient
+  class WebhookReceiversApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates a `WebhookReceiver` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param webhook_receiver_request [WebhookReceiverRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookReceiver]
+    def webhook_receivers_create(x_account_token, webhook_receiver_request, opts = {})
+      data, _status_code, _headers = webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request, opts)
+      data
+    end
+
+    # Creates a `WebhookReceiver` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param webhook_receiver_request [WebhookReceiverRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookReceiver, Integer, Hash)>] WebhookReceiver data, response status code and response headers
+    def webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookReceiversApi.webhook_receivers_create ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling WebhookReceiversApi.webhook_receivers_create"
+      end
+      # verify the required parameter 'webhook_receiver_request' is set
+      if @api_client.config.client_side_validation && webhook_receiver_request.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_receiver_request' when calling WebhookReceiversApi.webhook_receivers_create"
+      end
+      # resource path
+      local_var_path = '/webhook-receivers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_receiver_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebhookReceiver'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhookReceiversApi.webhook_receivers_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookReceiversApi#webhook_receivers_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of `WebhookReceiver` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<WebhookReceiver>]
+    def webhook_receivers_list(x_account_token, opts = {})
+      data, _status_code, _headers = webhook_receivers_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of &#x60;WebhookReceiver&#x60; objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<WebhookReceiver>, Integer, Hash)>] Array<WebhookReceiver> data, response status code and response headers
+    def webhook_receivers_list_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookReceiversApi.webhook_receivers_list ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling WebhookReceiversApi.webhook_receivers_list"
+      end
+      # resource path
+      local_var_path = '/webhook-receivers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<WebhookReceiver>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhookReceiversApi.webhook_receivers_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookReceiversApi#webhook_receivers_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_ats_client/configuration.rb

@@ -197,11 +197,13 @@ module MergeATSClient
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{key}"
       else
-        @api_key[param_name]
+        key
       end
     end
 
@@ -218,7 +220,7 @@ module MergeATSClient
             type: 'api_key',
             in: 'header',
             key: 'Authorization',
-            value: api_key_with_prefix('Authorization')
+            value: api_key_with_prefix('tokenAuth')
           },
       }
     end

data/lib/merge_ats_client/models/account_details.rb

@@ -19,6 +19,8 @@ module MergeATSClient
 
     attr_accessor :integration
 
+    attr_accessor :integration_slug
+
     attr_accessor :category
 
     attr_accessor :end_user_origin_id
@@ -29,16 +31,20 @@ module MergeATSClient
 
     attr_accessor :status
 
+    attr_accessor :webhook_listener_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'integration' => :'integration',
+        :'integration_slug' => :'integration_slug',
         :'category' => :'category',
         :'end_user_origin_id' => :'end_user_origin_id',
         :'end_user_organization_name' => :'end_user_organization_name',
         :'end_user_email_address' => :'end_user_email_address',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'webhook_listener_url' => :'webhook_listener_url'
       }
     end
 
@@ -52,11 +58,13 @@ module MergeATSClient
       {
         :'id' => :'String',
         :'integration' => :'String',
+        :'integration_slug' => :'String',
         :'category' => :'CategoryEnum',
         :'end_user_origin_id' => :'String',
         :'end_user_organization_name' => :'String',
         :'end_user_email_address' => :'String',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'webhook_listener_url' => :'String'
       }
     end
 
@@ -90,6 +98,10 @@ module MergeATSClient
         self.integration = attributes[:'integration']
       end
 
+      if attributes.key?(:'integration_slug')
+        self.integration_slug = attributes[:'integration_slug']
+      end
+
       if attributes.key?(:'category')
         self.category = attributes[:'category']
       end
@@ -109,6 +121,10 @@ module MergeATSClient
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
+
+      if attributes.key?(:'webhook_listener_url')
+        self.webhook_listener_url = attributes[:'webhook_listener_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -131,11 +147,13 @@ module MergeATSClient
       self.class == o.class &&
           id == o.id &&
           integration == o.integration &&
+          integration_slug == o.integration_slug &&
           category == o.category &&
           end_user_origin_id == o.end_user_origin_id &&
           end_user_organization_name == o.end_user_organization_name &&
           end_user_email_address == o.end_user_email_address &&
-          status == o.status
+          status == o.status &&
+          webhook_listener_url == o.webhook_listener_url
     end
 
     # @see the `==` method
@@ -147,7 +165,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, integration, category, end_user_origin_id, end_user_organization_name, end_user_email_address, status].hash
+      [id, integration, integration_slug, category, end_user_origin_id, end_user_organization_name, end_user_email_address, status, webhook_listener_url].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/account_details_and_actions.rb

@@ -22,12 +22,16 @@ module MergeATSClient
 
     attr_accessor :status
 
+    attr_accessor :status_detail
+
     attr_accessor :end_user_origin_id
 
     attr_accessor :end_user_organization_name
 
     attr_accessor :end_user_email_address
 
+    attr_accessor :webhook_listener_url
+
     attr_accessor :integration
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,9 +40,11 @@ module MergeATSClient
         :'id' => :'id',
         :'category' => :'category',
         :'status' => :'status',
+        :'status_detail' => :'status_detail',
         :'end_user_origin_id' => :'end_user_origin_id',
         :'end_user_organization_name' => :'end_user_organization_name',
         :'end_user_email_address' => :'end_user_email_address',
+        :'webhook_listener_url' => :'webhook_listener_url',
         :'integration' => :'integration'
       }
     end
@@ -54,9 +60,11 @@ module MergeATSClient
         :'id' => :'String',
         :'category' => :'CategoryEnum',
         :'status' => :'AccountDetailsAndActionsStatusEnum',
+        :'status_detail' => :'String',
         :'end_user_origin_id' => :'String',
         :'end_user_organization_name' => :'String',
         :'end_user_email_address' => :'String',
+        :'webhook_listener_url' => :'String',
         :'integration' => :'AccountDetailsAndActionsIntegration'
       }
     end
@@ -94,6 +102,10 @@ module MergeATSClient
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'status_detail')
+        self.status_detail = attributes[:'status_detail']
+      end
+
       if attributes.key?(:'end_user_origin_id')
         self.end_user_origin_id = attributes[:'end_user_origin_id']
       end
@@ -106,6 +118,10 @@ module MergeATSClient
         self.end_user_email_address = attributes[:'end_user_email_address']
       end
 
+      if attributes.key?(:'webhook_listener_url')
+        self.webhook_listener_url = attributes[:'webhook_listener_url']
+      end
+
       if attributes.key?(:'integration')
         self.integration = attributes[:'integration']
       end
@@ -131,6 +147,10 @@ module MergeATSClient
         invalid_properties.push('invalid value for "end_user_email_address", end_user_email_address cannot be nil.')
       end
 
+      if @webhook_listener_url.nil?
+        invalid_properties.push('invalid value for "webhook_listener_url", webhook_listener_url cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -141,6 +161,7 @@ module MergeATSClient
       return false if @status.nil?
       return false if @end_user_organization_name.nil?
       return false if @end_user_email_address.nil?
+      return false if @webhook_listener_url.nil?
       true
     end
 
@@ -152,9 +173,11 @@ module MergeATSClient
           id == o.id &&
           category == o.category &&
           status == o.status &&
+          status_detail == o.status_detail &&
           end_user_origin_id == o.end_user_origin_id &&
           end_user_organization_name == o.end_user_organization_name &&
           end_user_email_address == o.end_user_email_address &&
+          webhook_listener_url == o.webhook_listener_url &&
           integration == o.integration
     end
 
@@ -167,7 +190,7 @@ module MergeATSClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, category, status, end_user_origin_id, end_user_organization_name, end_user_email_address, integration].hash
+      [id, category, status, status_detail, end_user_origin_id, end_user_organization_name, end_user_email_address, webhook_listener_url, integration].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/account_details_and_actions_integration.rb

@@ -54,7 +54,7 @@ module MergeATSClient
     def self.openapi_types
       {
         :'name' => :'String',
-        :'categories' => :'CategoriesEnum',
+        :'categories' => :'Array<CategoriesEnum>',
         :'image' => :'String',
         :'square_image' => :'String',
         :'color' => :'String',
@@ -90,7 +90,9 @@ module MergeATSClient
       end
 
       if attributes.key?(:'categories')
-        self.categories = attributes[:'categories']
+        if (value = attributes[:'categories']).is_a?(Array)
+          self.categories = value
+        end
       end
 
       if attributes.key?(:'image')

data/lib/merge_ats_client/models/account_integration.rb

@@ -32,28 +32,6 @@ module MergeATSClient
 
     attr_accessor :slug
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -75,7 +53,7 @@ module MergeATSClient
     def self.openapi_types
       {
         :'name' => :'String',
-        :'categories' => :'Array<String>',
+        :'categories' => :'Array<CategoriesEnum>',
         :'image' => :'String',
         :'square_image' => :'String',
         :'color' => :'String',
@@ -242,7 +220,7 @@ module MergeATSClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_ats_client/models/account_token.rb

@@ -154,7 +154,7 @@ module MergeATSClient
       when :Date
         Date.parse(value)
       when :String
-        value.to_s
+        value
       when :Integer
         value.to_i
       when :Float

data/lib/merge_ats_client/models/activity.rb

@@ -14,14 +14,13 @@ 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 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 the performed the action.
     attr_accessor :user
 
     # When the third party's activity was created.
@@ -41,6 +40,9 @@ module MergeATSClient
 
     attr_accessor :remote_data
 
+    # Indicates whether or not this object has been deleted on the third-party.
+    attr_accessor :remote_was_deleted
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -52,7 +54,8 @@ module MergeATSClient
         :'subject' => :'subject',
         :'body' => :'body',
         :'visibility' => :'visibility',
-        :'remote_data' => :'remote_data'
+        :'remote_data' => :'remote_data',
+        :'remote_was_deleted' => :'remote_was_deleted'
       }
     end
 
@@ -72,7 +75,8 @@ module MergeATSClient
         :'subject' => :'String',
         :'body' => :'String',
         :'visibility' => :'VisibilityEnum',
-        :'remote_data' => :'Array<RemoteData>'
+        :'remote_data' => :'Array<RemoteData>',
+        :'remote_was_deleted' => :'Boolean'
       }
     end
 
@@ -86,7 +90,7 @@ module MergeATSClient
         :'subject',
         :'body',
         :'visibility',
-        :'remote_data'
+        :'remote_data',
       ])
     end
 
@@ -142,6 +146,10 @@ module MergeATSClient
           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,7 +178,8 @@ module MergeATSClient
           subject == o.subject &&
           body == o.body &&
           visibility == o.visibility &&
-          remote_data == o.remote_data
+          remote_data == o.remote_data &&
+          remote_was_deleted == o.remote_was_deleted
     end
 
     # @see the `==` method
@@ -182,7 +191,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].hash
+      [id, remote_id, user, remote_created_at, activity_type, subject, body, visibility, remote_data, remote_was_deleted].hash
     end
 
     # Builds the object from hash

data/lib/merge_ats_client/models/application.rb

@@ -14,17 +14,15 @@ require 'date'
 require 'time'
 
 module MergeATSClient
-  # # The Application Object ### Description The `Application` object is used to represent an Application for a job position.  ### 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 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.
   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.
@@ -36,13 +34,10 @@ 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
@@ -50,6 +45,8 @@ module MergeATSClient
     # Custom fields configured for a given model.
     attr_accessor :custom_fields
 
+    attr_accessor :remote_was_deleted
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -64,7 +61,8 @@ module MergeATSClient
         :'current_stage' => :'current_stage',
         :'reject_reason' => :'reject_reason',
         :'remote_data' => :'remote_data',
-        :'custom_fields' => :'custom_fields'
+        :'custom_fields' => :'custom_fields',
+        :'remote_was_deleted' => :'remote_was_deleted'
       }
     end
 
@@ -87,7 +85,8 @@ module MergeATSClient
         :'current_stage' => :'String',
         :'reject_reason' => :'String',
         :'remote_data' => :'Array<RemoteData>',
-        :'custom_fields' => :'Hash<String, Object>'
+        :'custom_fields' => :'Hash<String, AnyType>',
+        :'remote_was_deleted' => :'Boolean'
       }
     end
 
@@ -104,7 +103,7 @@ module MergeATSClient
         :'current_stage',
         :'reject_reason',
         :'remote_data',
-        :'custom_fields'
+        :'custom_fields',
       ])
     end
 
@@ -174,6 +173,10 @@ module MergeATSClient
           self.custom_fields = 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?
@@ -205,7 +208,8 @@ module MergeATSClient
           current_stage == o.current_stage &&
           reject_reason == o.reject_reason &&
           remote_data == o.remote_data &&
-          custom_fields == o.custom_fields
+          custom_fields == o.custom_fields &&
+          remote_was_deleted == o.remote_was_deleted
     end
 
     # @see the `==` method
@@ -217,7 +221,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].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
     end
 
     # Builds the object from hash