Skip to content

Latest commit

 

History

History
413 lines (269 loc) · 9.92 KB

AgreementWorkTypesApi.md

File metadata and controls

413 lines (269 loc) · 9.92 KB

Connectwise::AgreementWorkTypesApi

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

Method HTTP request Description
finance_agreements_id_worktypes_count_get GET /finance/agreements/{id}/worktypes/count
finance_agreements_id_worktypes_get GET /finance/agreements/{id}/worktypes
finance_agreements_id_worktypes_post POST /finance/agreements/{id}/worktypes
finance_agreements_id_worktypes_worktype_id_delete DELETE /finance/agreements/{id}/worktypes/{worktypeId}
finance_agreements_id_worktypes_worktype_id_get GET /finance/agreements/{id}/worktypes/{worktypeId}
finance_agreements_id_worktypes_worktype_id_patch PATCH /finance/agreements/{id}/worktypes/{worktypeId}
finance_agreements_id_worktypes_worktype_id_put PUT /finance/agreements/{id}/worktypes/{worktypeId}

finance_agreements_id_worktypes_count_get

Count finance_agreements_id_worktypes_count_get(id, opts)

Get Work Types 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::AgreementWorkTypesApi.new

id = 56 # Integer | 

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

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

finance_agreements_id_worktypes_get

Array<AgreementWorkType> finance_agreements_id_worktypes_get(id, opts)

Get Work Types

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::AgreementWorkTypesApi.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.finance_agreements_id_worktypes_get(id, opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling AgreementWorkTypesApi->finance_agreements_id_worktypes_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<AgreementWorkType>

Authorization

BasicAuth

HTTP request headers

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

finance_agreements_id_worktypes_post

AgreementWorkType finance_agreements_id_worktypes_post(id, work_type)

Create Work Type

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

id = 56 # Integer | 

work_type = Connectwise::AgreementWorkType.new # AgreementWorkType | 


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

Parameters

Name Type Description Notes
id Integer
work_type AgreementWorkType

Return type

AgreementWorkType

Authorization

BasicAuth

HTTP request headers

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

finance_agreements_id_worktypes_worktype_id_delete

finance_agreements_id_worktypes_worktype_id_delete(id, worktype_id)

Delete Work Type 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::AgreementWorkTypesApi.new

id = 56 # Integer | 

worktype_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
worktype_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

finance_agreements_id_worktypes_worktype_id_get

AgreementWorkType finance_agreements_id_worktypes_worktype_id_get(id, worktype_id)

Get Work Type 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::AgreementWorkTypesApi.new

id = 56 # Integer | 

worktype_id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer
worktype_id Integer

Return type

AgreementWorkType

Authorization

BasicAuth

HTTP request headers

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

finance_agreements_id_worktypes_worktype_id_patch

AgreementWorkType finance_agreements_id_worktypes_worktype_id_patch(id, worktype_id, operations)

Update Work Type

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

id = 56 # Integer | 

worktype_id = 56 # Integer | 

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


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

Parameters

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

Return type

AgreementWorkType

Authorization

BasicAuth

HTTP request headers

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

finance_agreements_id_worktypes_worktype_id_put

AgreementWorkType finance_agreements_id_worktypes_worktype_id_put(id, worktype_id, work_type)

Replace Work Type

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

id = 56 # Integer | 

worktype_id = 56 # Integer | 

work_type = Connectwise::AgreementWorkType.new # AgreementWorkType | 


begin
  result = api_instance.finance_agreements_id_worktypes_worktype_id_put(id, worktype_id, work_type)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling AgreementWorkTypesApi->finance_agreements_id_worktypes_worktype_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
worktype_id Integer
work_type AgreementWorkType

Return type

AgreementWorkType

Authorization

BasicAuth

HTTP request headers

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