Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 9.79 KB

GroupCompaniesApi.md

File metadata and controls

413 lines (269 loc) · 9.79 KB
Raw

Connectwise::GroupCompaniesApi

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

Method HTTP request Description
marketing_groups_id_companies_company_id_delete DELETE /marketing/groups/{id}/companies/{companyId}
marketing_groups_id_companies_company_id_get GET /marketing/groups/{id}/companies/{companyId}
marketing_groups_id_companies_company_id_patch PATCH /marketing/groups/{id}/companies/{companyId}
marketing_groups_id_companies_company_id_put PUT /marketing/groups/{id}/companies/{companyId}
marketing_groups_id_companies_count_get GET /marketing/groups/{id}/companies/count
marketing_groups_id_companies_get GET /marketing/groups/{id}/companies
marketing_groups_id_companies_post POST /marketing/groups/{id}/companies

marketing_groups_id_companies_company_id_delete

marketing_groups_id_companies_company_id_delete(id, company_id)

Delete Marketing 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::GroupCompaniesApi.new

id = 56 # Integer | 

company_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
company_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

marketing_groups_id_companies_company_id_get

MarketingCompany marketing_groups_id_companies_company_id_get(id, company_id)

Get Marketing 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::GroupCompaniesApi.new

id = 56 # Integer | 

company_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
company_id Integer

Return type

MarketingCompany

Authorization

BasicAuth

HTTP request headers

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

marketing_groups_id_companies_company_id_patch

MarketingCompany marketing_groups_id_companies_company_id_patch(id, company_id, operations)

Update Marketing 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::GroupCompaniesApi.new

id = 56 # Integer | 

company_id = 56 # Integer | 

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


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

Parameters

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

Return type

MarketingCompany

Authorization

BasicAuth

HTTP request headers

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

marketing_groups_id_companies_company_id_put

MarketingCompany marketing_groups_id_companies_company_id_put(id, company_id, marketing_company)

Replace Marketing 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::GroupCompaniesApi.new

id = 56 # Integer | 

company_id = 56 # Integer | 

marketing_company = Connectwise::MarketingCompany.new # MarketingCompany | 


begin
  result = api_instance.marketing_groups_id_companies_company_id_put(id, company_id, marketing_company)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling GroupCompaniesApi->marketing_groups_id_companies_company_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
company_id Integer
marketing_company MarketingCompany

Return type

MarketingCompany

Authorization

BasicAuth

HTTP request headers

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

marketing_groups_id_companies_count_get

Count marketing_groups_id_companies_count_get(id, opts)

Get Marketing Companys 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::GroupCompaniesApi.new

id = 56 # Integer | 

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

begin
  result = api_instance.marketing_groups_id_companies_count_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling GroupCompaniesApi->marketing_groups_id_companies_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

marketing_groups_id_companies_get

Array<MarketingCompany> marketing_groups_id_companies_get(id, opts)

Get Marketing Companys

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::GroupCompaniesApi.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.marketing_groups_id_companies_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling GroupCompaniesApi->marketing_groups_id_companies_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<MarketingCompany>

Authorization

BasicAuth

HTTP request headers

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

marketing_groups_id_companies_post

MarketingCompany marketing_groups_id_companies_post(id, marketing_company)

Create Marketing 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::GroupCompaniesApi.new

id = 56 # Integer | 

marketing_company = Connectwise::MarketingCompany.new # MarketingCompany | 


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

Parameters

Name Type Description Notes
id Integer
marketing_company MarketingCompany

Return type

MarketingCompany

Authorization

BasicAuth

HTTP request headers

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