README.md

Application

(application)

Overview

Available Operations

• create_ats_application - Create an application
• get_ats_application - Retrieve an application
• list_ats_applications - List all applications
• patch_ats_application - Update an application
• remove_ats_application - Remove an application
• update_ats_application - Update an application

create_ats_application

Create an application

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.application.create_ats_application(connection_id="<id>", ats_application=::UnifiedRubySDK::Shared::AtsApplication.new(), fields_=[
  "<value>",
])

if ! res.ats_application.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
ats_application	T.nilable(::UnifiedRubySDK::Shared::AtsApplication)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAtsApplicationResponse)

get_ats_application

Retrieve an application

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.application.get_ats_application(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.ats_application.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Application
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAtsApplicationResponse)

list_ats_applications

List all applications

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAtsApplicationsRequest.new(
  connection_id: "<id>",
)
    
res = s.application.list_ats_applications(req)

if ! res.ats_applications.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListAtsApplicationsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAtsApplicationsResponse)

patch_ats_application

Update an application

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.application.patch_ats_application(connection_id="<id>", id="<id>", ats_application=::UnifiedRubySDK::Shared::AtsApplication.new(), fields_=[
  "<value>",
])

if ! res.ats_application.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Application
ats_application	T.nilable(::UnifiedRubySDK::Shared::AtsApplication)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAtsApplicationResponse)

remove_ats_application

Remove an application

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.application.remove_ats_application(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Application

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAtsApplicationResponse)

update_ats_application

Update an application

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.application.update_ats_application(connection_id="<id>", id="<id>", ats_application=::UnifiedRubySDK::Shared::AtsApplication.new(), fields_=[
  "<value>",
])

if ! res.ats_application.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Application
ats_application	T.nilable(::UnifiedRubySDK::Shared::AtsApplication)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAtsApplicationResponse)