Company

(company)

Overview

Available Operations

create_crm_company - Create a company
create_hris_company - Create a company
get_ats_company - Retrieve a company
get_crm_company - Retrieve a company
get_hris_company - Retrieve a company
list_ats_companies - List all companies
list_crm_companies - List all companies
list_enrich_companies - Retrieve enrichment information for a company
list_hris_companies - List all companies
patch_crm_company - Update a company
patch_hris_company - Update a company
remove_crm_company - Remove a company
remove_hris_company - Remove a company
update_crm_company - Update a company
update_hris_company - Update a company

create_crm_company

Create a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.create_crm_company(connection_id="<id>", crm_company=::UnifiedRubySDK::Shared::CrmCompany.new(), fields_=[
  "<value>",
])

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

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`crm_company`	T.nilable(::UnifiedRubySDK::Shared::CrmCompany)	➖	A company represents an organization that optionally is associated with a deal and/or contacts
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

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

create_hris_company

Create a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.create_hris_company(connection_id="<id>", hris_company=::UnifiedRubySDK::Shared::HrisCompany.new(), fields_=[
  "<value>",
])

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

Parameters

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

Response

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

get_ats_company

Retrieve a company

Example Usage

require 'unified_ruby_sdk'


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

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

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

Parameters

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

Response

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

get_crm_company

Retrieve a company

Example Usage

require 'unified_ruby_sdk'


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

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

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

Parameters

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

Response

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

get_hris_company

Retrieve a company

Example Usage

require 'unified_ruby_sdk'


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

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

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

Parameters

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

Response

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

list_ats_companies

List all companies

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::ListAtsCompaniesRequest.new(
  connection_id: "<id>",
)
    
res = s.company.list_ats_companies(req)

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

Parameters

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

Response

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

list_crm_companies

List all companies

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::ListCrmCompaniesRequest.new(
  connection_id: "<id>",
)
    
res = s.company.list_crm_companies(req)

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

Parameters

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

Response

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

list_enrich_companies

Retrieve enrichment information for a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.list_enrich_companies(connection_id="<id>", domain="distinct-wheel.info", name="<value>")

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

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`domain`	T.nilable(::String)	➖	The domain of the company to search
`name`	T.nilable(::String)	➖	The name of the company to search

Response

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

list_hris_companies

List all companies

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::ListHrisCompaniesRequest.new(
  connection_id: "<id>",
)
    
res = s.company.list_hris_companies(req)

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

Parameters

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

Response

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

patch_crm_company

Update a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.patch_crm_company(connection_id="<id>", id="<id>", crm_company=::UnifiedRubySDK::Shared::CrmCompany.new(), fields_=[
  "<value>",
])

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

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Company
`crm_company`	T.nilable(::UnifiedRubySDK::Shared::CrmCompany)	➖	A company represents an organization that optionally is associated with a deal and/or contacts
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

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

patch_hris_company

Update a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.patch_hris_company(connection_id="<id>", id="<id>", hris_company=::UnifiedRubySDK::Shared::HrisCompany.new(), fields_=[
  "<value>",
])

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

Parameters

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

Response

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

remove_crm_company

Remove a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.remove_crm_company(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 Company

Response

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

remove_hris_company

Remove a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.remove_hris_company(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 Company

Response

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

update_crm_company

Update a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.update_crm_company(connection_id="<id>", id="<id>", crm_company=::UnifiedRubySDK::Shared::CrmCompany.new(), fields_=[
  "<value>",
])

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

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Company
`crm_company`	T.nilable(::UnifiedRubySDK::Shared::CrmCompany)	➖	A company represents an organization that optionally is associated with a deal and/or contacts
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

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

update_hris_company

Update a company

Example Usage

require 'unified_ruby_sdk'


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

    
res = s.company.update_hris_company(connection_id="<id>", id="<id>", hris_company=::UnifiedRubySDK::Shared::HrisCompany.new(), fields_=[
  "<value>",
])

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

Parameters

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

Response

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

Files

README.md

Latest commit

History

README.md

File metadata and controls

Company

Overview

Available Operations

create_crm_company

Example Usage

Parameters

Response

create_hris_company

Example Usage

Parameters

Response

get_ats_company

Example Usage

Parameters

Response

get_crm_company

Example Usage

Parameters

Response

get_hris_company

Example Usage

Parameters

Response

list_ats_companies

Example Usage

Parameters

Response

list_crm_companies

Example Usage

Parameters

Response

list_enrich_companies

Example Usage

Parameters

Response

list_hris_companies

Example Usage

Parameters

Response

patch_crm_company

Example Usage

Parameters

Response

patch_hris_company

Example Usage

Parameters

Response

remove_crm_company

Example Usage

Parameters

Response

remove_hris_company

Example Usage

Parameters

Response

update_crm_company

Example Usage

Parameters

Response

update_hris_company

Example Usage

Parameters

Response