docs/LinksApi.md in connectwise-ruby-sdk-1.0.3 vs docs/LinksApi.md in connectwise-ruby-sdk-2.0.0
- old
+ new
@@ -1,6 +1,6 @@
-# Connectwise::LinksApi
+# ConnectWise::LinksApi
All URIs are relative to *https://api-na.myconnectwise.net/v4_6_release/apis/3.0*
Method | HTTP request | Description
------------- | ------------- | -------------
@@ -23,26 +23,26 @@
### Example
```ruby
# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
-Connectwise.configure do |config|
+ConnectWise.configure do |config|
# Configure HTTP basic authorization: BasicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = Connectwise::LinksApi.new
+api_instance = ConnectWise::LinksApi.new
opts = {
conditions: "conditions_example" # String |
}
begin
result = api_instance.system_links_count_get(opts)
p result
-rescue Connectwise::ApiError => e
+rescue ConnectWise::ApiError => e
puts "Exception when calling LinksApi->system_links_count_get: #{e}"
end
```
### Parameters
@@ -76,39 +76,43 @@
### Example
```ruby
# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
-Connectwise.configure do |config|
+ConnectWise.configure do |config|
# Configure HTTP basic authorization: BasicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = Connectwise::LinksApi.new
+api_instance = ConnectWise::LinksApi.new
opts = {
conditions: "conditions_example" # String |
order_by: "order_by_example", # String |
+ childconditions: "childconditions_example", # String |
+ customfieldconditions: "customfieldconditions_example", # String |
page: 56, # Integer |
page_size: 56 # Integer |
}
begin
result = api_instance.system_links_get(opts)
p result
-rescue Connectwise::ApiError => e
+rescue ConnectWise::ApiError => e
puts "Exception when calling LinksApi->system_links_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**conditions** | **String**| | [optional]
**order_by** | **String**| | [optional]
+ **childconditions** | **String**| | [optional]
+ **customfieldconditions** | **String**| | [optional]
**page** | **Integer**| | [optional]
**page_size** | **Integer**| | [optional]
### Return type
@@ -135,24 +139,24 @@
### Example
```ruby
# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
-Connectwise.configure do |config|
+ConnectWise.configure do |config|
# Configure HTTP basic authorization: BasicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = Connectwise::LinksApi.new
+api_instance = ConnectWise::LinksApi.new
id = 56 # Integer |
begin
api_instance.system_links_id_delete(id)
-rescue Connectwise::ApiError => e
+rescue ConnectWise::ApiError => e
puts "Exception when calling LinksApi->system_links_id_delete: #{e}"
end
```
### Parameters
@@ -186,25 +190,25 @@
### Example
```ruby
# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
-Connectwise.configure do |config|
+ConnectWise.configure do |config|
# Configure HTTP basic authorization: BasicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = Connectwise::LinksApi.new
+api_instance = ConnectWise::LinksApi.new
id = 56 # Integer |
begin
result = api_instance.system_links_id_get(id)
p result
-rescue Connectwise::ApiError => e
+rescue ConnectWise::ApiError => e
puts "Exception when calling LinksApi->system_links_id_get: #{e}"
end
```
### Parameters
@@ -238,27 +242,27 @@
### Example
```ruby
# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
-Connectwise.configure do |config|
+ConnectWise.configure do |config|
# Configure HTTP basic authorization: BasicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = Connectwise::LinksApi.new
+api_instance = ConnectWise::LinksApi.new
id = 56 # Integer |
-operations = [Connectwise::PatchOperation.new] # Array<PatchOperation> |
+operations = [ConnectWise::PatchOperation.new] # Array<PatchOperation> |
begin
result = api_instance.system_links_id_patch(id, operations)
p result
-rescue Connectwise::ApiError => e
+rescue ConnectWise::ApiError => e
puts "Exception when calling LinksApi->system_links_id_patch: #{e}"
end
```
### Parameters
@@ -293,27 +297,27 @@
### Example
```ruby
# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
-Connectwise.configure do |config|
+ConnectWise.configure do |config|
# Configure HTTP basic authorization: BasicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = Connectwise::LinksApi.new
+api_instance = ConnectWise::LinksApi.new
id = 56 # Integer |
-link = Connectwise::Link.new # Link |
+link = ConnectWise::Link.new # Link |
begin
result = api_instance.system_links_id_put(id, link)
p result
-rescue Connectwise::ApiError => e
+rescue ConnectWise::ApiError => e
puts "Exception when calling LinksApi->system_links_id_put: #{e}"
end
```
### Parameters
@@ -348,24 +352,24 @@
### Example
```ruby
# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
-Connectwise.configure do |config|
+ConnectWise.configure do |config|
# Configure HTTP basic authorization: BasicAuth
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
-api_instance = Connectwise::LinksApi.new
+api_instance = ConnectWise::LinksApi.new
-link = Connectwise::Link.new # Link |
+link = ConnectWise::Link.new # Link |
begin
result = api_instance.system_links_post(link)
p result
-rescue Connectwise::ApiError => e
+rescue ConnectWise::ApiError => e
puts "Exception when calling LinksApi->system_links_post: #{e}"
end
```
### Parameters