class MergeATSClient::ApplicationsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/merge_ats_client/api/applications_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

applications_create(x_account_token, remote_user_id, opts = {}) click to toggle source

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]

# File lib/merge_ats_client/api/applications_api.rb, line 29
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
applications_create_with_http_info(x_account_token, remote_user_id, opts = {}) click to toggle source

Creates an &#x60;Application&#x60; 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

# File lib/merge_ats_client/api/applications_api.rb, line 41
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
applications_list(x_account_token, opts = {}) click to toggle source

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]

# File lib/merge_ats_client/api/applications_api.rb, line 116
def applications_list(x_account_token, opts = {})
  data, _status_code, _headers = applications_list_with_http_info(x_account_token, opts)
  data
end
applications_list_with_http_info(x_account_token, opts = {}) click to toggle source

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

# File lib/merge_ats_client/api/applications_api.rb, line 139
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
applications_partial_update(x_account_token, id, remote_user_id, opts = {}) click to toggle source

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]

# File lib/merge_ats_client/api/applications_api.rb, line 214
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
applications_partial_update_with_http_info(x_account_token, id, remote_user_id, opts = {}) click to toggle source

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

# File lib/merge_ats_client/api/applications_api.rb, line 227
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
applications_retrieve(x_account_token, id, opts = {}) click to toggle source

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]

# File lib/merge_ats_client/api/applications_api.rb, line 295
def applications_retrieve(x_account_token, id, opts = {})
  data, _status_code, _headers = applications_retrieve_with_http_info(x_account_token, id, opts)
  data
end
applications_retrieve_with_http_info(x_account_token, id, opts = {}) click to toggle source

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

# File lib/merge_ats_client/api/applications_api.rb, line 307
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