Skip to content

Latest commit

 

History

History
392 lines (255 loc) · 9.54 KB

ConnectWiseHostedSetupsApi.md

File metadata and controls

392 lines (255 loc) · 9.54 KB
Raw

Connectwise::ConnectWiseHostedSetupsApi

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

Method HTTP request Description
system_connectwisehostedsetups_count_get GET /system/connectwisehostedsetups/count
system_connectwisehostedsetups_get GET /system/connectwisehostedsetups
system_connectwisehostedsetups_id_delete DELETE /system/connectwisehostedsetups/{id}
system_connectwisehostedsetups_id_get GET /system/connectwisehostedsetups/{id}
system_connectwisehostedsetups_id_patch PATCH /system/connectwisehostedsetups/{id}
system_connectwisehostedsetups_id_put PUT /system/connectwisehostedsetups/{id}
system_connectwisehostedsetups_post POST /system/connectwisehostedsetups

system_connectwisehostedsetups_count_get

Count system_connectwisehostedsetups_count_get(opts)

Get Connect Wise Hosted Setups 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::ConnectWiseHostedSetupsApi.new

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

begin
  result = api_instance.system_connectwisehostedsetups_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ConnectWiseHostedSetupsApi->system_connectwisehostedsetups_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

system_connectwisehostedsetups_get

Array<ConnectWiseHostedSetup> system_connectwisehostedsetups_get(opts)

Get Connect Wise Hosted Setups

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

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

begin
  result = api_instance.system_connectwisehostedsetups_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ConnectWiseHostedSetupsApi->system_connectwisehostedsetups_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<ConnectWiseHostedSetup>

Authorization

BasicAuth

HTTP request headers

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

system_connectwisehostedsetups_id_delete

system_connectwisehostedsetups_id_delete(id)

Delete Connect Wise Hosted Setup 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::ConnectWiseHostedSetupsApi.new

id = 56 # Integer | 


begin
  api_instance.system_connectwisehostedsetups_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling ConnectWiseHostedSetupsApi->system_connectwisehostedsetups_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

system_connectwisehostedsetups_id_get

ConnectWiseHostedSetup system_connectwisehostedsetups_id_get(id)

Get Connect Wise Hosted Setup 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::ConnectWiseHostedSetupsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

ConnectWiseHostedSetup

Authorization

BasicAuth

HTTP request headers

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

system_connectwisehostedsetups_id_patch

ConnectWiseHostedSetup system_connectwisehostedsetups_id_patch(id, operations)

Update Connect Wise Hosted Setup

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

id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

ConnectWiseHostedSetup

Authorization

BasicAuth

HTTP request headers

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

system_connectwisehostedsetups_id_put

ConnectWiseHostedSetup system_connectwisehostedsetups_id_put(id, connect_wise_hosted_setup)

Replace Connect Wise Hosted Setup

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

id = 56 # Integer | 

connect_wise_hosted_setup = Connectwise::ConnectWiseHostedSetup.new # ConnectWiseHostedSetup | 


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

Parameters

Name Type Description Notes
id Integer
connect_wise_hosted_setup ConnectWiseHostedSetup

Return type

ConnectWiseHostedSetup

Authorization

BasicAuth

HTTP request headers

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

system_connectwisehostedsetups_post

ConnectWiseHostedSetup system_connectwisehostedsetups_post(connect_wise_hosted_setup)

Create Connect Wise Hosted Setup

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

connect_wise_hosted_setup = Connectwise::ConnectWiseHostedSetup.new # ConnectWiseHostedSetup | 


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

Parameters

Name Type Description Notes
connect_wise_hosted_setup ConnectWiseHostedSetup

Return type

ConnectWiseHostedSetup

Authorization

BasicAuth

HTTP request headers

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