Skip to content

Latest commit

 

History

History
448 lines (291 loc) · 9.23 KB

CompaniesApi.md

File metadata and controls

448 lines (291 loc) · 9.23 KB
Raw

Connectwise::CompaniesApi

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
company_companies_count_get GET /company/companies/count
company_companies_get GET /company/companies
company_companies_id_delete DELETE /company/companies/{id}
company_companies_id_get GET /company/companies/{id}
company_companies_id_merge_post POST /company/companies/{id}/merge
company_companies_id_patch PATCH /company/companies/{id}
company_companies_id_put PUT /company/companies/{id}
company_companies_post POST /company/companies

company_companies_count_get

Count company_companies_count_get(opts)

Get Companies Count

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

opts = { 
  conditions: "conditions_example" # String | 
}

begin
  result = api_instance.company_companies_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_count_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

company_companies_get

Array<Company> company_companies_get(opts)

Get Companies

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.company_companies_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]
order_by String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<Company>

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

company_companies_id_delete

company_companies_id_delete(id)

Delete Company By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

id = 56 # Integer | 


begin
  api_instance.company_companies_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

company_companies_id_get

Company company_companies_id_get(id)

Get Company By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

id = 56 # Integer | 


begin
  result = api_instance.company_companies_id_get(id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

Company

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

company_companies_id_merge_post

SuccessResponse company_companies_id_merge_post(id, merge)

Merge Company

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

id = 56 # Integer | 

merge = Connectwise::CompanyMerge.new # CompanyMerge | 


begin
  result = api_instance.company_companies_id_merge_post(id, merge)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_id_merge_post: #{e}"
end

Parameters

Name Type Description Notes
id Integer
merge CompanyMerge

Return type

SuccessResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

company_companies_id_patch

Company company_companies_id_patch(id, operations)

Update Company

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

id = 56 # Integer | 

operations = [Connectwise::PatchOperation.new] # Array<PatchOperation> | 


begin
  result = api_instance.company_companies_id_patch(id, operations)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_id_patch: #{e}"
end

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

Company

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

company_companies_id_put

Company company_companies_id_put(id, company)

Replace Company

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

id = 56 # Integer | 

company = Connectwise::Company.new # Company | 


begin
  result = api_instance.company_companies_id_put(id, company)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
company Company

Return type

Company

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

company_companies_post

Company company_companies_post(company)

Create Company

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::CompaniesApi.new

company = Connectwise::Company.new # Company | 


begin
  result = api_instance.company_companies_post(company)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompaniesApi->company_companies_post: #{e}"
end

Parameters

Name Type Description Notes
company Company

Return type

Company

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json