Class: Merge::Ats::AsyncApplicationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/ats/applications/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Ats::AsyncApplicationsClient

Parameters:



284
285
286
 
# File 'lib/merge_ruby_client/ats/applications/client.rb', line 284

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



280
281
282
 
# File 'lib/merge_ruby_client/ats/applications/client.rb', line 280

def request_client
  @request_client
end

Instance Method Details

#change_stage_create(id:, is_debug_mode: nil, run_async: nil, job_interview_stage: nil, remote_user_id: nil, request_options: nil) ⇒ Merge::Ats::ApplicationResponse

Updates the current_stage field of an Application object

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ats.applications.change_stage_create(id: "id")

Parameters:

  • id (String)
  • is_debug_mode (Boolean) (defaults to: nil) —

    Whether to include debug fields (such as log file links) in the response.

  • run_async (Boolean) (defaults to: nil) —

    Whether or not third-party updates should be run asynchronously.

  • job_interview_stage (String) (defaults to: nil) —

    The interview stage to move the application to.

  • remote_user_id (String) (defaults to: nil)
  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/merge_ruby_client/ats/applications/client.rb', line 485

def change_stage_create(id:, is_debug_mode: nil, run_async: nil, job_interview_stage: nil, remote_user_id: nil,
                        request_options: nil)
  Async do
    response = @request_client.conn.post do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "is_debug_mode": is_debug_mode,
        "run_async": run_async
      }.compact
      req.body = {
        **(request_options&.additional_body_parameters || {}),
        job_interview_stage: job_interview_stage,
        remote_user_id: remote_user_id
      }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/applications/#{id}/change-stage"
    end
    Merge::Ats::ApplicationResponse.from_json(json_object: response.body)
  end
end

#create(model:, remote_user_id:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Ats::ApplicationResponse

Creates an Application object with the given values.

For certain integrations, but not all, our API detects duplicate candidates and
will associate applications with existing records in the third-party. New
candidates are created and automatically linked to the application.
See our [Help Center
tps://help.merge.dev/en/articles/10012366-updates-to-post-applications-oct-2024)
for detailed support per integration.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ats.applications.create(model: {  }, remote_user_id: "remote_user_id")

Parameters:

  • is_debug_mode (Boolean) (defaults to: nil) —

    Whether to include debug fields (such as log file links) in the response.

  • run_async (Boolean) (defaults to: nil) —

    Whether or not third-party updates should be run asynchronously.

  • model (Hash) —

    Request of type Merge::Ats::ApplicationRequest, as a Hash

    • :candidate (Hash)

    • :job (Hash)

    • :applied_at (DateTime)

    • :rejected_at (DateTime)

    • :offers (Array<Merge::Ats::ApplicationRequestOffersItem>)

    • :source (String)

    • :credited_to (Hash)

    • :screening_question_answers (Array<Merge::Ats::ApplicationRequestScreeningQuestionAnswersItem>)

    • :current_stage (Hash)

    • :reject_reason (Hash)

    • :remote_template_id (String)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

  • remote_user_id (String)
  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/merge_ruby_client/ats/applications/client.rb', line 398

def create(model:, remote_user_id:, is_debug_mode: nil, run_async: nil, request_options: nil)
  Async do
    response = @request_client.conn.post do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "is_debug_mode": is_debug_mode,
        "run_async": run_async
      }.compact
      req.body = {
        **(request_options&.additional_body_parameters || {}),
        model: model,
        remote_user_id: remote_user_id
      }.compact
      req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/applications"
    end
    Merge::Ats::ApplicationResponse.from_json(json_object: response.body)
  end
end

#list(candidate_id: nil, created_after: nil, created_before: nil, credited_to_id: nil, current_stage_id: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, job_id: nil, modified_after: nil, modified_before: nil, page_size: nil, reject_reason_id: nil, remote_id: nil, source: nil, request_options: nil) ⇒ Merge::Ats::PaginatedApplicationList

Returns a list of Application objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ats.applications.list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

  • candidate_id (String) (defaults to: nil) —

    If provided, will only return applications for this candidate.

  • created_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

  • credited_to_id (String) (defaults to: nil) —

    If provided, will only return applications credited to this user.

  • current_stage_id (String) (defaults to: nil) —

    If provided, will only return applications at this interview stage.

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • expand (Merge::Ats::Applications::ApplicationsListRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_deleted_data (Boolean) (defaults to: nil) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • job_id (String) (defaults to: nil) —

    If provided, will only return applications for this job.

  • modified_after (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge after this date time will be returned.

  • modified_before (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge before this date time will be returned.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • reject_reason_id (String) (defaults to: nil) —

    If provided, will only return applications with this reject reason.

  • remote_id (String) (defaults to: nil) —

    The API provider’s ID for the given object.

  • source (String) (defaults to: nil) —

    If provided, will only return applications with this source.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/merge_ruby_client/ats/applications/client.rb', line 323

def list(candidate_id: nil, created_after: nil, created_before: nil, credited_to_id: nil, current_stage_id: nil,
         cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, job_id: nil, modified_after: nil, modified_before: nil, page_size: nil, reject_reason_id: nil, remote_id: nil, source: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "candidate_id": candidate_id,
        "created_after": created_after,
        "created_before": created_before,
        "credited_to_id": credited_to_id,
        "current_stage_id": current_stage_id,
        "cursor": cursor,
        "expand": expand,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data,
        "job_id": job_id,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "reject_reason_id": reject_reason_id,
        "remote_id": remote_id,
        "source": source
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/applications"
    end
    Merge::Ats::PaginatedApplicationList.from_json(json_object: response.body)
  end
end

#meta_post_retrieve(application_remote_template_id: nil, request_options: nil) ⇒ Merge::Ats::MetaResponse

Returns metadata for Application POSTs.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ats.applications.meta_post_retrieve

Parameters:

  • application_remote_template_id (String) (defaults to: nil) —

    The template ID associated with the nested application in the request.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/merge_ruby_client/ats/applications/client.rb', line 525

def meta_post_retrieve(application_remote_template_id: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "application_remote_template_id": application_remote_template_id
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/applications/meta/post"
    end
    Merge::Ats::MetaResponse.from_json(json_object: response.body)
  end
end

#retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil) ⇒ Merge::Ats::Application

Returns an Application object with the given id.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.ats.applications.retrieve(id: "id")

Parameters:

  • id (String)
  • expand (Merge::Ats::Applications::ApplicationsRetrieveRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/merge_ruby_client/ats/applications/client.rb', line 443

def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "expand": expand,
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/applications/#{id}"
    end
    Merge::Ats::Application.from_json(json_object: response.body)
  end
end