merge_ats_client 1.0.2 → 2.0.0

data/docs/WebhookReceiversApi.md

@@ -0,0 +1,153 @@
+# MergeATSClient::WebhookReceiversApi
+
+All URIs are relative to *https://api.merge.dev/api/ats/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**webhook_receivers_create**](WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers |  |
+| [**webhook_receivers_list**](WebhookReceiversApi.md#webhook_receivers_list) | **GET** /webhook-receivers |  |
+
+
+## webhook_receivers_create
+
+> <WebhookReceiver> webhook_receivers_create(x_account_token, webhook_receiver_request)
+
+
+
+Creates a `WebhookReceiver` object with the given values.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeATSClient::WebhookReceiversApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+webhook_receiver_request = MergeATSClient::WebhookReceiverRequest.new({event: 'event_example', is_active: false}) # WebhookReceiverRequest | 
+
+begin
+  
+  result = api_instance.webhook_receivers_create(x_account_token, webhook_receiver_request)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_create: #{e}"
+end
+```
+
+#### Using the webhook_receivers_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookReceiver>, Integer, Hash)> webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.webhook_receivers_create_with_http_info(x_account_token, webhook_receiver_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookReceiver>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **webhook_receiver_request** | [**WebhookReceiverRequest**](WebhookReceiverRequest.md) |  |  |
+
+### Return type
+
+[**WebhookReceiver**](WebhookReceiver.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## webhook_receivers_list
+
+> <Array<WebhookReceiver>> webhook_receivers_list(x_account_token)
+
+
+
+Returns a list of `WebhookReceiver` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_ats_client'
+# setup authorization
+MergeATSClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeATSClient::WebhookReceiversApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.webhook_receivers_list(x_account_token)
+  p result
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_list: #{e}"
+end
+```
+
+#### Using the webhook_receivers_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<WebhookReceiver>>, Integer, Hash)> webhook_receivers_list_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.webhook_receivers_list_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<WebhookReceiver>>
+rescue MergeATSClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**Array&lt;WebhookReceiver&gt;**](WebhookReceiver.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/lib/merge_ats_client/api/account_details_api.rb

@@ -0,0 +1,84 @@
+=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 AccountDetailsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get details for a linked account.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [AccountDetails]
+    def account_details_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = account_details_retrieve_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Get details for a linked account.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountDetails, Integer, Hash)>] AccountDetails data, response status code and response headers
+    def account_details_retrieve_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDetailsApi.account_details_retrieve ...'
+      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 AccountDetailsApi.account_details_retrieve"
+      end
+      # resource path
+      local_var_path = '/account-details'
+
+      # 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] || 'AccountDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountDetailsApi.account_details_retrieve",
+        :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: AccountDetailsApi#account_details_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_ats_client/api/account_token_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 Contact: hello@merge.dev
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.1
 
 =end
 

data/lib/merge_ats_client/api/activities_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 Contact: hello@merge.dev
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -26,6 +26,7 @@ module MergeATSClient
     # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -45,6 +46,7 @@ module MergeATSClient
     # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
     # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
@@ -73,6 +75,7 @@ module MergeATSClient
       query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
       query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
       query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
       query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
       query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?

data/lib/merge_ats_client/api/applications_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 Contact: hello@merge.dev
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -21,24 +21,24 @@ module MergeATSClient
     end
     # Creates an `Application` object with the given values.
     # @param x_account_token [String] Token identifying the end user.
-    # @param remote_user_id [String] The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
+    # @param application_endpoint_request [ApplicationEndpointRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
     # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
-    # @option opts [ApplicationRequest] :application_request 
-    # @return [Application]
-    def applications_create(x_account_token, remote_user_id, opts = {})
-      data, _status_code, _headers = applications_create_with_http_info(x_account_token, remote_user_id, opts)
+    # @return [ApplicationResponse]
+    def applications_create(x_account_token, application_endpoint_request, opts = {})
+      data, _status_code, _headers = applications_create_with_http_info(x_account_token, application_endpoint_request, opts)
       data
     end
 
     # Creates an `Application` object with the given values.
     # @param x_account_token [String] Token identifying the end user.
-    # @param remote_user_id [String] The ID of the RemoteUser deleting the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.
+    # @param application_endpoint_request [ApplicationEndpointRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
     # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
-    # @option opts [ApplicationRequest] :application_request 
-    # @return [Array<(Application, Integer, Hash)>] Application data, response status code and response headers
-    def applications_create_with_http_info(x_account_token, remote_user_id, opts = {})
+    # @return [Array<(ApplicationResponse, Integer, Hash)>] ApplicationResponse data, response status code and response headers
+    def applications_create_with_http_info(x_account_token, application_endpoint_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_create ...'
       end
@@ -46,16 +46,16 @@ module MergeATSClient
       if @api_client.config.client_side_validation && x_account_token.nil?
         fail ArgumentError, "Missing the required parameter 'x_account_token' when calling ApplicationsApi.applications_create"
       end
-      # verify the required parameter 'remote_user_id' is set
-      if @api_client.config.client_side_validation && remote_user_id.nil?
-        fail ArgumentError, "Missing the required parameter 'remote_user_id' when calling ApplicationsApi.applications_create"
+      # verify the required parameter 'application_endpoint_request' is set
+      if @api_client.config.client_side_validation && application_endpoint_request.nil?
+        fail ArgumentError, "Missing the required parameter 'application_endpoint_request' when calling ApplicationsApi.applications_create"
       end
       # resource path
       local_var_path = '/applications'
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'remote_user_id'] = remote_user_id
+      query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil?
       query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
 
       # header parameters
@@ -70,10 +70,10 @@ module MergeATSClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'application_request'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(application_endpoint_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Application'
+      return_type = opts[:debug_return_type] || 'ApplicationResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['tokenAuth']
@@ -105,6 +105,7 @@ module MergeATSClient
     # @option opts [String] :current_stage_id If provided, will only return applications at this interview stage.
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [String] :job_id If provided, will only return applications for this job.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
@@ -112,6 +113,7 @@ module MergeATSClient
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :reject_reason_id If provided, will only return applications with this reject reason.
     # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
+    # @option opts [String] :source If provided, will only return applications with this source.
     # @return [PaginatedApplicationList]
     def applications_list(x_account_token, opts = {})
       data, _status_code, _headers = applications_list_with_http_info(x_account_token, opts)
@@ -128,6 +130,7 @@ module MergeATSClient
     # @option opts [String] :current_stage_id If provided, will only return applications at this interview stage.
     # @option opts [String] :cursor The pagination cursor value.
     # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_deleted_data Whether to include data that was deleted in the third-party service.
     # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
     # @option opts [String] :job_id If provided, will only return applications for this job.
     # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
@@ -135,6 +138,7 @@ module MergeATSClient
     # @option opts [Integer] :page_size Number of results to return per page.
     # @option opts [String] :reject_reason_id If provided, will only return applications with this reject reason.
     # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
+    # @option opts [String] :source If provided, will only return applications with this source.
     # @return [Array<(PaginatedApplicationList, Integer, Hash)>] PaginatedApplicationList data, response status code and response headers
     def applications_list_with_http_info(x_account_token, opts = {})
       if @api_client.config.debugging
@@ -160,6 +164,7 @@ module MergeATSClient
       query_params[:'current_stage_id'] = opts[:'current_stage_id'] if !opts[:'current_stage_id'].nil?
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
       query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
       query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
       query_params[:'job_id'] = opts[:'job_id'] if !opts[:'job_id'].nil?
       query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
@@ -167,6 +172,7 @@ module MergeATSClient
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'reject_reason_id'] = opts[:'reject_reason_id'] if !opts[:'reject_reason_id'].nil?
       query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -203,6 +209,71 @@ module MergeATSClient
       return data, status_code, headers
     end
 
+    # Returns metadata for `Application` POSTs.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :application_remote_template_id The template ID associated with the nested application in the request.
+    # @return [MetaResponse]
+    def applications_meta_post_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = applications_meta_post_retrieve_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns metadata for &#x60;Application&#x60; POSTs.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :application_remote_template_id The template ID associated with the nested application in the request.
+    # @return [Array<(MetaResponse, Integer, Hash)>] MetaResponse data, response status code and response headers
+    def applications_meta_post_retrieve_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_meta_post_retrieve ...'
+      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 ApplicationsApi.applications_meta_post_retrieve"
+      end
+      # resource path
+      local_var_path = '/applications/meta/post'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'application_remote_template_id'] = opts[:'application_remote_template_id'] if !opts[:'application_remote_template_id'].nil?
+
+      # 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] || 'MetaResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ApplicationsApi.applications_meta_post_retrieve",
+        :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: ApplicationsApi#applications_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Returns an `Application` object with the given `id`.
     # @param x_account_token [String] Token identifying the end user.
     # @param id [String]