merge_ats_client 1.0.1

data/lib/merge_ats_client.rb

@@ -0,0 +1,131 @@
+=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.0.0
+
+=end
+
+# Common files
+require 'merge_ats_client/api_client'
+require 'merge_ats_client/api_error'
+require 'merge_ats_client/version'
+require 'merge_ats_client/configuration'
+
+# Models
+require 'merge_ats_client/models/access_role_enum'
+require 'merge_ats_client/models/account_integration'
+require 'merge_ats_client/models/account_token'
+require 'merge_ats_client/models/activity'
+require 'merge_ats_client/models/activity_type_enum'
+require 'merge_ats_client/models/application'
+require 'merge_ats_client/models/application_request'
+require 'merge_ats_client/models/attachment'
+require 'merge_ats_client/models/available_actions'
+require 'merge_ats_client/models/candidate'
+require 'merge_ats_client/models/data_passthrough'
+require 'merge_ats_client/models/candidate_request'
+require 'merge_ats_client/models/data_passthrough_request'
+require 'merge_ats_client/models/department'
+require 'merge_ats_client/models/disability_status_enum'
+require 'merge_ats_client/models/eeoc'
+require 'merge_ats_client/models/email_address'
+require 'merge_ats_client/models/email_address_request'
+require 'merge_ats_client/models/email_address_type_enum'
+require 'merge_ats_client/models/end_user_details'
+require 'merge_ats_client/models/end_user_details_request'
+require 'merge_ats_client/models/gender_enum'
+require 'merge_ats_client/models/generate_remote_key_request'
+require 'merge_ats_client/models/job'
+require 'merge_ats_client/models/job_interview_stage'
+require 'merge_ats_client/models/job_status_enum'
+require 'merge_ats_client/models/link_token'
+require 'merge_ats_client/models/method_enum'
+require 'merge_ats_client/models/model_operation'
+require 'merge_ats_client/models/offer'
+require 'merge_ats_client/models/offer_status_enum'
+require 'merge_ats_client/models/office'
+require 'merge_ats_client/models/overall_recommendation_enum'
+require 'merge_ats_client/models/paginated_activity_list'
+require 'merge_ats_client/models/paginated_application_list'
+require 'merge_ats_client/models/paginated_attachment_list'
+require 'merge_ats_client/models/paginated_candidate_list'
+require 'merge_ats_client/models/paginated_department_list'
+require 'merge_ats_client/models/paginated_eeoc_list'
+require 'merge_ats_client/models/paginated_job_interview_stage_list'
+require 'merge_ats_client/models/paginated_job_list'
+require 'merge_ats_client/models/paginated_offer_list'
+require 'merge_ats_client/models/paginated_office_list'
+require 'merge_ats_client/models/paginated_reject_reason_list'
+require 'merge_ats_client/models/paginated_remote_user_list'
+require 'merge_ats_client/models/paginated_scheduled_interview_list'
+require 'merge_ats_client/models/paginated_scorecard_list'
+require 'merge_ats_client/models/paginated_tag_list'
+require 'merge_ats_client/models/patched_application_request'
+require 'merge_ats_client/models/phone_number'
+require 'merge_ats_client/models/phone_number_request'
+require 'merge_ats_client/models/phone_number_type_enum'
+require 'merge_ats_client/models/race_enum'
+require 'merge_ats_client/models/reject_reason'
+require 'merge_ats_client/models/remote_data'
+require 'merge_ats_client/models/remote_data_request'
+require 'merge_ats_client/models/remote_key'
+require 'merge_ats_client/models/remote_key_for_regeneration_request'
+require 'merge_ats_client/models/remote_response'
+require 'merge_ats_client/models/remote_user'
+require 'merge_ats_client/models/scheduled_interview'
+require 'merge_ats_client/models/scheduled_interview_status_enum'
+require 'merge_ats_client/models/scorecard'
+require 'merge_ats_client/models/sync_status'
+require 'merge_ats_client/models/tag'
+require 'merge_ats_client/models/url'
+require 'merge_ats_client/models/url_request'
+require 'merge_ats_client/models/url_type_enum'
+require 'merge_ats_client/models/veteran_status_enum'
+require 'merge_ats_client/models/visibility_enum'
+
+# APIs
+require 'merge_ats_client/api/account_token_api'
+require 'merge_ats_client/api/activities_api'
+require 'merge_ats_client/api/applications_api'
+require 'merge_ats_client/api/attachments_api'
+require 'merge_ats_client/api/available_actions_api'
+require 'merge_ats_client/api/candidates_api'
+require 'merge_ats_client/api/departments_api'
+require 'merge_ats_client/api/eeocs_api'
+require 'merge_ats_client/api/generate_key_api'
+require 'merge_ats_client/api/interviews_api'
+require 'merge_ats_client/api/job_interview_stages_api'
+require 'merge_ats_client/api/jobs_api'
+require 'merge_ats_client/api/link_token_api'
+require 'merge_ats_client/api/offers_api'
+require 'merge_ats_client/api/offices_api'
+require 'merge_ats_client/api/passthrough_api'
+require 'merge_ats_client/api/regenerate_key_api'
+require 'merge_ats_client/api/reject_reasons_api'
+require 'merge_ats_client/api/scorecards_api'
+require 'merge_ats_client/api/sync_status_api'
+require 'merge_ats_client/api/tags_api'
+require 'merge_ats_client/api/users_api'
+
+module MergeATSClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   MergeATSClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/merge_ats_client/api/account_token_api.rb

@@ -0,0 +1,83 @@
+=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.0.0
+
+=end
+
+require 'cgi'
+
+module MergeATSClient
+  class AccountTokenApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns the account token for the end user with the provided public token.
+    # @param public_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountToken]
+    def account_token_retrieve(public_token, opts = {})
+      data, _status_code, _headers = account_token_retrieve_with_http_info(public_token, opts)
+      data
+    end
+
+    # Returns the account token for the end user with the provided public token.
+    # @param public_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountToken, Integer, Hash)>] AccountToken data, response status code and response headers
+    def account_token_retrieve_with_http_info(public_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountTokenApi.account_token_retrieve ...'
+      end
+      # verify the required parameter 'public_token' is set
+      if @api_client.config.client_side_validation && public_token.nil?
+        fail ArgumentError, "Missing the required parameter 'public_token' when calling AccountTokenApi.account_token_retrieve"
+      end
+      # resource path
+      local_var_path = '/account-token/{public_token}'.sub('{' + 'public_token' + '}', CGI.escape(public_token.to_s))
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountToken'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountTokenApi.account_token_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: AccountTokenApi#account_token_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/activities_api.rb

@@ -0,0 +1,196 @@
+=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.0.0
+
+=end
+
+require 'cgi'
+
+module MergeATSClient
+  class ActivitiesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns a list of `Activity` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @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_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.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @option opts [String] :user_id If provided, will only return activities done by this user.
+    # @return [PaginatedActivityList]
+    def activities_list(x_account_token, opts = {})
+      data, _status_code, _headers = activities_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of `Activity` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @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_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.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider's ID for the given object.
+    # @option opts [String] :user_id If provided, will only return activities done by this user.
+    # @return [Array<(PaginatedActivityList, Integer, Hash)>] PaginatedActivityList data, response status code and response headers
+    def activities_list_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_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 ActivitiesApi.activities_list"
+      end
+      allowable_values = ["user"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/activities'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      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_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?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+      query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_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] || 'PaginatedActivityList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ActivitiesApi.activities_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: ActivitiesApi#activities_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns an `Activity` object with the given `id`.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @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_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Activity]
+    def activities_retrieve(x_account_token, id, opts = {})
+      data, _status_code, _headers = activities_retrieve_with_http_info(x_account_token, id, opts)
+      data
+    end
+
+    # Returns an &#x60;Activity&#x60; object with the given &#x60;id&#x60;.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @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_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Array<(Activity, Integer, Hash)>] Activity data, response status code and response headers
+    def activities_retrieve_with_http_info(x_account_token, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActivitiesApi.activities_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 ActivitiesApi.activities_retrieve"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ActivitiesApi.activities_retrieve"
+      end
+      allowable_values = ["user"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/activities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].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] || 'Activity'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ActivitiesApi.activities_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: ActivitiesApi#activities_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/applications_api.rb

@@ -0,0 +1,366 @@
+=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.0.0
+
+=end
+
+require 'cgi'
+
+module MergeATSClient
+  class ApplicationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    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 [Hash] opts the optional parameters
+    # @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)
+      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 [Hash] opts the optional parameters
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_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 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"
+      end
+      # resource path
+      local_var_path = '/applications'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'remote_user_id'] = remote_user_id
+      query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
+
+      # 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(opts[:'application_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Application'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ApplicationsApi.applications_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: ApplicationsApi#applications_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of `Application` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :candidate_id If provided, will only return applications for this candidate.
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :credited_to_id If provided, will only return applications credited to this user.
+    # @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_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.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @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.
+    # @return [PaginatedApplicationList]
+    def applications_list(x_account_token, opts = {})
+      data, _status_code, _headers = applications_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of &#x60;Application&#x60; objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :candidate_id If provided, will only return applications for this candidate.
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :credited_to_id If provided, will only return applications credited to this user.
+    # @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_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.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @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.
+    # @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
+        @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_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 ApplicationsApi.applications_list"
+      end
+      allowable_values = ["candidate", "candidate,credited_to", "candidate,credited_to,current_stage", "candidate,credited_to,current_stage,reject_reason", "candidate,credited_to,reject_reason", "candidate,current_stage", "candidate,current_stage,reject_reason", "candidate,job", "candidate,job,credited_to", "candidate,job,credited_to,current_stage", "candidate,job,credited_to,current_stage,reject_reason", "candidate,job,credited_to,reject_reason", "candidate,job,current_stage", "candidate,job,current_stage,reject_reason", "candidate,job,reject_reason", "candidate,reject_reason", "credited_to", "credited_to,current_stage", "credited_to,current_stage,reject_reason", "credited_to,reject_reason", "current_stage", "current_stage,reject_reason", "job", "job,credited_to", "job,credited_to,current_stage", "job,credited_to,current_stage,reject_reason", "job,credited_to,reject_reason", "job,current_stage", "job,current_stage,reject_reason", "job,reject_reason", "reject_reason"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/applications'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'candidate_id'] = opts[:'candidate_id'] if !opts[:'candidate_id'].nil?
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'credited_to_id'] = opts[:'credited_to_id'] if !opts[:'credited_to_id'].nil?
+      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_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?
+      query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
+      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?
+
+      # 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] || 'PaginatedApplicationList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ApplicationsApi.applications_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: ApplicationsApi#applications_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Updates an `Application` object with the given `id`.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @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 [Hash] opts the optional parameters
+    # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
+    # @option opts [PatchedApplicationRequest] :patched_application_request 
+    # @return [Application]
+    def applications_partial_update(x_account_token, id, remote_user_id, opts = {})
+      data, _status_code, _headers = applications_partial_update_with_http_info(x_account_token, id, remote_user_id, opts)
+      data
+    end
+
+    # Updates an &#x60;Application&#x60; object with the given &#x60;id&#x60;.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @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 [Hash] opts the optional parameters
+    # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
+    # @option opts [PatchedApplicationRequest] :patched_application_request 
+    # @return [Array<(Application, Integer, Hash)>] Application data, response status code and response headers
+    def applications_partial_update_with_http_info(x_account_token, id, remote_user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_partial_update ...'
+      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_partial_update"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ApplicationsApi.applications_partial_update"
+      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_partial_update"
+      end
+      # resource path
+      local_var_path = '/applications/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'remote_user_id'] = remote_user_id
+      query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
+
+      # 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(opts[:'patched_application_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Application'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ApplicationsApi.applications_partial_update",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApplicationsApi#applications_partial_update\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] 
+    # @param [Hash] opts the optional parameters
+    # @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_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Application]
+    def applications_retrieve(x_account_token, id, opts = {})
+      data, _status_code, _headers = applications_retrieve_with_http_info(x_account_token, id, opts)
+      data
+    end
+
+    # Returns an &#x60;Application&#x60; object with the given &#x60;id&#x60;.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @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_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Array<(Application, Integer, Hash)>] Application data, response status code and response headers
+    def applications_retrieve_with_http_info(x_account_token, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApplicationsApi.applications_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_retrieve"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ApplicationsApi.applications_retrieve"
+      end
+      allowable_values = ["candidate", "candidate,credited_to", "candidate,credited_to,current_stage", "candidate,credited_to,current_stage,reject_reason", "candidate,credited_to,reject_reason", "candidate,current_stage", "candidate,current_stage,reject_reason", "candidate,job", "candidate,job,credited_to", "candidate,job,credited_to,current_stage", "candidate,job,credited_to,current_stage,reject_reason", "candidate,job,credited_to,reject_reason", "candidate,job,current_stage", "candidate,job,current_stage,reject_reason", "candidate,job,reject_reason", "candidate,reject_reason", "credited_to", "credited_to,current_stage", "credited_to,current_stage,reject_reason", "credited_to,reject_reason", "current_stage", "current_stage,reject_reason", "job", "job,credited_to", "job,credited_to,current_stage", "job,credited_to,current_stage,reject_reason", "job,credited_to,reject_reason", "job,current_stage", "job,current_stage,reject_reason", "job,reject_reason", "reject_reason"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/applications/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].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] || 'Application'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ApplicationsApi.applications_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_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end