Class: ConnectWise::AgreementWorkRoleExclusionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AgreementWorkRoleExclusionsApi

Returns a new instance of AgreementWorkRoleExclusionsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 8

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#finance_agreements_id_work_role_exclusions_count_get(id, opts = {}) ⇒ Count

Get Work Role Exclusions Count

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



18
19
20
21
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 18

def finance_agreements_id_work_role_exclusions_count_get(id, opts = {})
  data, _status_code, _headers = finance_agreements_id_work_role_exclusions_count_get_with_http_info(id, opts)
  return data
end

#finance_agreements_id_work_role_exclusions_count_get_with_http_info(id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Work Role Exclusions Count

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

  • (Array<(Count, Fixnum, Hash)>) —

    Count data, response status code and response headers



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 29

def finance_agreements_id_work_role_exclusions_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_count_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_count_get"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/workRoleExclusions/count".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementWorkRoleExclusionsApi#finance_agreements_id_work_role_exclusions_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_work_role_exclusions_get(id, opts = {}) ⇒ Array<AgreementWorkRoleExclusion>

Get Work Role Exclusions

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



79
80
81
82
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 79

def finance_agreements_id_work_role_exclusions_get(id, opts = {})
  data, _status_code, _headers = finance_agreements_id_work_role_exclusions_get_with_http_info(id, opts)
  return data
end

#finance_agreements_id_work_role_exclusions_get_with_http_info(id, opts = {}) ⇒ Array<(Array<AgreementWorkRoleExclusion>, Fixnum, Hash)>

Get Work Role Exclusions

Parameters:

  • id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

  • (Array<(Array<AgreementWorkRoleExclusion>, Fixnum, Hash)>) —

    Array<AgreementWorkRoleExclusion> data, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 95

def finance_agreements_id_work_role_exclusions_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_get"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/workRoleExclusions".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AgreementWorkRoleExclusion>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementWorkRoleExclusionsApi#finance_agreements_id_work_role_exclusions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_work_role_exclusions_post(id, work_role_exclusion, opts = {}) ⇒ AgreementWorkRoleExclusion

Create Work Role Exclusion

Parameters:

  • id
  • work_role_exclusion
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 145

def finance_agreements_id_work_role_exclusions_post(id, work_role_exclusion, opts = {})
  data, _status_code, _headers = finance_agreements_id_work_role_exclusions_post_with_http_info(id, work_role_exclusion, opts)
  return data
end

#finance_agreements_id_work_role_exclusions_post_with_http_info(id, work_role_exclusion, opts = {}) ⇒ Array<(AgreementWorkRoleExclusion, Fixnum, Hash)>

Create Work Role Exclusion

Parameters:

  • id
  • work_role_exclusion
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AgreementWorkRoleExclusion, Fixnum, Hash)>) —

    AgreementWorkRoleExclusion data, response status code and response headers



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 156

def finance_agreements_id_work_role_exclusions_post_with_http_info(id, work_role_exclusion, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_post ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_post"
  end
  # verify the required parameter 'work_role_exclusion' is set
  if @api_client.config.client_side_validation && work_role_exclusion.nil?
    fail ArgumentError, "Missing the required parameter 'work_role_exclusion' when calling AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_post"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/workRoleExclusions".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(work_role_exclusion)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AgreementWorkRoleExclusion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementWorkRoleExclusionsApi#finance_agreements_id_work_role_exclusions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete(id, work_role_exclusion_id, opts = {}) ⇒ nil

Delete Work Role Exclusion By Id

Parameters:

  • id
  • work_role_exclusion_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


206
207
208
209
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 206

def finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete(id, work_role_exclusion_id, opts = {})
  finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete_with_http_info(id, work_role_exclusion_id, opts)
  return nil
end

#finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete_with_http_info(id, work_role_exclusion_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Work Role Exclusion By Id

Parameters:

  • id
  • work_role_exclusion_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/connectwise-ruby-sdk/api/agreement_work_role_exclusions_api.rb', line 217

def finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete_with_http_info(id, work_role_exclusion_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete"
  end
  # verify the required parameter 'work_role_exclusion_id' is set
  if @api_client.config.client_side_validation && work_role_exclusion_id.nil?
    fail ArgumentError, "Missing the required parameter 'work_role_exclusion_id' when calling AgreementWorkRoleExclusionsApi.finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete"
  end
  # resource path
  local_var_path = "/finance/agreements/{id}/workRoleExclusions/{workRoleExclusionId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'workRoleExclusionId' + '}', work_role_exclusion_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgreementWorkRoleExclusionsApi#finance_agreements_id_work_role_exclusions_work_role_exclusion_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end