Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 9.17 KB

CompanySitesApi.md

File metadata and controls

413 lines (269 loc) · 9.17 KB
Raw

Connectwise::CompanySitesApi

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

Method HTTP request Description
company_companies_id_sites_count_get GET /company/companies/{id}/sites/count
company_companies_id_sites_get GET /company/companies/{id}/sites
company_companies_id_sites_post POST /company/companies/{id}/sites
company_companies_id_sites_site_id_delete DELETE /company/companies/{id}/sites/{siteId}
company_companies_id_sites_site_id_get GET /company/companies/{id}/sites/{siteId}
company_companies_id_sites_site_id_patch PATCH /company/companies/{id}/sites/{siteId}
company_companies_id_sites_site_id_put PUT /company/companies/{id}/sites/{siteId}

company_companies_id_sites_count_get

Count company_companies_id_sites_count_get(id, opts)

Get Sites 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::CompanySitesApi.new

id = 56 # Integer | 

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

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

Parameters

Name Type Description Notes
id Integer
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

company_companies_id_sites_get

Array<CompanySite> company_companies_id_sites_get(id, opts)

Get Sites

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::CompanySitesApi.new

id = 56 # Integer | 

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

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

Parameters

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

Return type

Array<CompanySite>

Authorization

BasicAuth

HTTP request headers

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

company_companies_id_sites_post

CompanySite company_companies_id_sites_post(id, site)

Create Site

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::CompanySitesApi.new

id = 56 # Integer | 

site = Connectwise::CompanySite.new # CompanySite | 


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

Parameters

Name Type Description Notes
id Integer
site CompanySite

Return type

CompanySite

Authorization

BasicAuth

HTTP request headers

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

company_companies_id_sites_site_id_delete

company_companies_id_sites_site_id_delete(id, site_id)

Delete Site 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::CompanySitesApi.new

id = 56 # Integer | 

site_id = 56 # Integer | 


begin
  api_instance.company_companies_id_sites_site_id_delete(id, site_id)
rescue Connectwise::ApiError => e
  puts "Exception when calling CompanySitesApi->company_companies_id_sites_site_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer
site_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

company_companies_id_sites_site_id_get

CompanySite company_companies_id_sites_site_id_get(id, site_id)

Get Site 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::CompanySitesApi.new

id = 56 # Integer | 

site_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
site_id Integer

Return type

CompanySite

Authorization

BasicAuth

HTTP request headers

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

company_companies_id_sites_site_id_patch

CompanySite company_companies_id_sites_site_id_patch(id, site_id, operations)

Update Site

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::CompanySitesApi.new

id = 56 # Integer | 

site_id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
site_id Integer
operations Array<PatchOperation>

Return type

CompanySite

Authorization

BasicAuth

HTTP request headers

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

company_companies_id_sites_site_id_put

CompanySite company_companies_id_sites_site_id_put(id, site_id, site)

Replace Site

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::CompanySitesApi.new

id = 56 # Integer | 

site_id = 56 # Integer | 

site = Connectwise::CompanySite.new # CompanySite | 


begin
  result = api_instance.company_companies_id_sites_site_id_put(id, site_id, site)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling CompanySitesApi->company_companies_id_sites_site_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
site_id Integer
site CompanySite

Return type

CompanySite

Authorization

BasicAuth

HTTP request headers

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