Skip to content

Latest commit

 

History

History
392 lines (255 loc) · 9.33 KB

ContactRelationshipsApi.md

File metadata and controls

392 lines (255 loc) · 9.33 KB
Raw

Connectwise::ContactRelationshipsApi

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

Method HTTP request Description
company_contacts_relationships_count_get GET /company/contacts/relationships/count
company_contacts_relationships_get GET /company/contacts/relationships
company_contacts_relationships_id_delete DELETE /company/contacts/relationships/{id}
company_contacts_relationships_id_get GET /company/contacts/relationships/{id}
company_contacts_relationships_id_patch PATCH /company/contacts/relationships/{id}
company_contacts_relationships_id_put PUT /company/contacts/relationships/{id}
company_contacts_relationships_post POST /company/contacts/relationships

company_contacts_relationships_count_get

Count company_contacts_relationships_count_get(opts)

Get Contact Relationships 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::ContactRelationshipsApi.new

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

begin
  result = api_instance.company_contacts_relationships_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactRelationshipsApi->company_contacts_relationships_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_contacts_relationships_get

Array<ContactRelationship> company_contacts_relationships_get(opts)

Get Contact Relationships

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

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

begin
  result = api_instance.company_contacts_relationships_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactRelationshipsApi->company_contacts_relationships_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<ContactRelationship>

Authorization

BasicAuth

HTTP request headers

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

company_contacts_relationships_id_delete

company_contacts_relationships_id_delete(id)

Delete Contact Relationship 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::ContactRelationshipsApi.new

id = 56 # Integer | 


begin
  api_instance.company_contacts_relationships_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactRelationshipsApi->company_contacts_relationships_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_contacts_relationships_id_get

ContactRelationship company_contacts_relationships_id_get(id)

Get Contact Relationship 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::ContactRelationshipsApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

ContactRelationship

Authorization

BasicAuth

HTTP request headers

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

company_contacts_relationships_id_patch

ContactRelationship company_contacts_relationships_id_patch(id, operations)

Update Contact Relationship

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

id = 56 # Integer | 

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


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

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

ContactRelationship

Authorization

BasicAuth

HTTP request headers

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

company_contacts_relationships_id_put

ContactRelationship company_contacts_relationships_id_put(id, contact_relationship)

Replace Contact Relationship

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

id = 56 # Integer | 

contact_relationship = Connectwise::ContactRelationship.new # ContactRelationship | 


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

Parameters

Name Type Description Notes
id Integer
contact_relationship ContactRelationship

Return type

ContactRelationship

Authorization

BasicAuth

HTTP request headers

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

company_contacts_relationships_post

ContactRelationship company_contacts_relationships_post(contact_relationship)

Create Contact Relationship

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

contact_relationship = Connectwise::ContactRelationship.new # ContactRelationship | 


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

Parameters

Name Type Description Notes
contact_relationship ContactRelationship

Return type

ContactRelationship

Authorization

BasicAuth

HTTP request headers

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