Class: ConnectWise::TicketsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TicketsApi

Returns a new instance of TicketsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/tickets_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/tickets_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#service_tickets_count_get(opts = {}) ⇒ Count

Get Tickets Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_conditions (String)

Returns:



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

def service_tickets_count_get(opts = {})
  data, _status_code, _headers = service_tickets_count_get_with_http_info(opts)
  return data
end

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

Get Tickets Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :custom_field_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
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 29

def service_tickets_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_count_get ..."
  end
  # resource path
  local_var_path = "/service/tickets/count"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'customFieldConditions'] = opts[:'custom_field_conditions'] if !opts[:'custom_field_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: TicketsApi#service_tickets_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_get(opts = {}) ⇒ Array<Ticket>

Get Tickets

Parameters:

  • 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:



75
76
77
78
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 75

def service_tickets_get(opts = {})
  data, _status_code, _headers = service_tickets_get_with_http_info(opts)
  return data
end

#service_tickets_get_with_http_info(opts = {}) ⇒ Array<(Array<Ticket>, Fixnum, Hash)>

Get Tickets

Parameters:

  • 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<Ticket>, Fixnum, Hash)>) —

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



90
91
92
93
94
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
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 90

def service_tickets_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_get ..."
  end
  # resource path
  local_var_path = "/service/tickets"

  # 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<Ticket>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Gets count of activities associated to the ticket /// Please use the /sales/activities/count?conditions=ticket/id=id endpoint

Parameters:

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 135

def service_tickets_id_activities_count_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_activities_count_get_with_http_info(id, opts)
  return data
end

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

Gets count of activities associated to the ticket /// Please use the /sales/activities/count?conditions&#x3D;ticket/id&#x3D;id endpoint

Parameters:

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

    the optional parameters

Returns:

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

    Count data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
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
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 145

def service_tickets_id_activities_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_activities_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 TicketsApi.service_tickets_id_activities_count_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/activities/count".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'])

  # 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: TicketsApi#service_tickets_id_activities_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_activities_get(id, opts = {}) ⇒ Array<ActivityReference>

Gets activities associated to the ticket /// Please use the /sales/activities?conditions=ticket/id=id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



190
191
192
193
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 190

def service_tickets_id_activities_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_activities_get_with_http_info(id, opts)
  return data
end

#service_tickets_id_activities_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ActivityReference>, Fixnum, Hash)>

Gets activities associated to the ticket /// Please use the /sales/activities?conditions&#x3D;ticket/id&#x3D;id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 202

def service_tickets_id_activities_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_activities_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 TicketsApi.service_tickets_id_activities_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/activities".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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<ActivityReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_activities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_configurations_config_id_delete(id, config_id, opts = {}) ⇒ nil

Delete Configuration Association

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


248
249
250
251
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 248

def service_tickets_id_configurations_config_id_delete(id, config_id, opts = {})
  service_tickets_id_configurations_config_id_delete_with_http_info(id, config_id, opts)
  return nil
end

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

Delete Configuration Association

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 259

def service_tickets_id_configurations_config_id_delete_with_http_info(id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_configurations_config_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 TicketsApi.service_tickets_id_configurations_config_id_delete"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling TicketsApi.service_tickets_id_configurations_config_id_delete"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/configurations/{configId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'configId' + '}', config_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: TicketsApi#service_tickets_id_configurations_config_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_configurations_config_id_get(id, config_id, opts = {}) ⇒ ConfigurationReference

Get Configuration Association

Parameters:

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

    the optional parameters

Returns:



304
305
306
307
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 304

def service_tickets_id_configurations_config_id_get(id, config_id, opts = {})
  data, _status_code, _headers = service_tickets_id_configurations_config_id_get_with_http_info(id, config_id, opts)
  return data
end

#service_tickets_id_configurations_config_id_get_with_http_info(id, config_id, opts = {}) ⇒ Array<(ConfigurationReference, Fixnum, Hash)>

Get Configuration Association

Parameters:

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

    the optional parameters

Returns:

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

    ConfigurationReference data, response status code and response headers



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 315

def service_tickets_id_configurations_config_id_get_with_http_info(id, config_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_configurations_config_id_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 TicketsApi.service_tickets_id_configurations_config_id_get"
  end
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling TicketsApi.service_tickets_id_configurations_config_id_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/configurations/{configId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'configId' + '}', config_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'])

  # 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 => 'ConfigurationReference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_configurations_config_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Ticket Configurations Count

Parameters:

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

    the optional parameters

Returns:



362
363
364
365
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 362

def service_tickets_id_configurations_count_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_configurations_count_get_with_http_info(id, opts)
  return data
end

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

Get Ticket Configurations Count

Parameters:

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

    the optional parameters

Returns:

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

    Count data, response status code and response headers



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 372

def service_tickets_id_configurations_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_configurations_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 TicketsApi.service_tickets_id_configurations_count_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/configurations/count".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'])

  # 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: TicketsApi#service_tickets_id_configurations_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_configurations_get(id, opts = {}) ⇒ Array<ConfigurationReference>

Get Ticket Configurations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



417
418
419
420
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 417

def service_tickets_id_configurations_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_configurations_get_with_http_info(id, opts)
  return data
end

#service_tickets_id_configurations_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ConfigurationReference>, Fixnum, Hash)>

Get Ticket Configurations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 429

def service_tickets_id_configurations_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_configurations_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 TicketsApi.service_tickets_id_configurations_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/configurations".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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<ConfigurationReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_configurations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_configurations_post(id, configuration, opts = {}) ⇒ ConfigurationReference

Create Configuration Association

Parameters:

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

    the optional parameters

Returns:



475
476
477
478
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 475

def service_tickets_id_configurations_post(id, configuration, opts = {})
  data, _status_code, _headers = service_tickets_id_configurations_post_with_http_info(id, configuration, opts)
  return data
end

#service_tickets_id_configurations_post_with_http_info(id, configuration, opts = {}) ⇒ Array<(ConfigurationReference, Fixnum, Hash)>

Create Configuration Association

Parameters:

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

    the optional parameters

Returns:

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

    ConfigurationReference data, response status code and response headers



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 486

def service_tickets_id_configurations_post_with_http_info(id, configuration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_configurations_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 TicketsApi.service_tickets_id_configurations_post"
  end
  # verify the required parameter 'configuration' is set
  if @api_client.config.client_side_validation && configuration.nil?
    fail ArgumentError, "Missing the required parameter 'configuration' when calling TicketsApi.service_tickets_id_configurations_post"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/configurations".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(configuration)
  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 => 'ConfigurationReference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_configurations_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_delete(id, opts = {}) ⇒ nil

Delete Ticket By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


535
536
537
538
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 535

def service_tickets_id_delete(id, opts = {})
  service_tickets_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Ticket By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 545

def service_tickets_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_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 TicketsApi.service_tickets_id_delete"
  end
  # resource path
  local_var_path = "/service/tickets/{id}".sub('{' + 'id' + '}', 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: TicketsApi#service_tickets_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Ticket Documents Count

Parameters:

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

    the optional parameters

Returns:



585
586
587
588
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 585

def service_tickets_id_documents_count_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_documents_count_get_with_http_info(id, opts)
  return data
end

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

Get Ticket Documents Count

Parameters:

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

    the optional parameters

Returns:

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

    Count data, response status code and response headers



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 595

def service_tickets_id_documents_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_documents_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 TicketsApi.service_tickets_id_documents_count_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/documents/count".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'])

  # 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: TicketsApi#service_tickets_id_documents_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_documents_get(id, opts = {}) ⇒ Array<DocumentReference>

Gets the documents associated to the ticket /// Please use the /system/documents?recordType=Ticket&amp;recordId=id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



640
641
642
643
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 640

def service_tickets_id_documents_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_documents_get_with_http_info(id, opts)
  return data
end

#service_tickets_id_documents_get_with_http_info(id, opts = {}) ⇒ Array<(Array<DocumentReference>, Fixnum, Hash)>

Gets the documents associated to the ticket /// Please use the /system/documents?recordType&#x3D;Ticket&amp;amp;recordId&#x3D;id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 652

def service_tickets_id_documents_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_documents_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 TicketsApi.service_tickets_id_documents_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/documents".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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<DocumentReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_get(id, opts = {}) ⇒ Ticket

Get Ticket By Id

Parameters:

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

    the optional parameters

Returns:



697
698
699
700
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 697

def service_tickets_id_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_get_with_http_info(id, opts)
  return data
end

#service_tickets_id_get_with_http_info(id, opts = {}) ⇒ Array<(Ticket, Fixnum, Hash)>

Get Ticket By Id

Parameters:

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

    the optional parameters

Returns:

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

    Ticket data, response status code and response headers



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 707

def service_tickets_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_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 TicketsApi.service_tickets_id_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}".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'])

  # 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 => 'Ticket')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_merge_post(id, merge, opts = {}) ⇒ SuccessResponse

Merge Company

Parameters:

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

    the optional parameters

Returns:



751
752
753
754
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 751

def service_tickets_id_merge_post(id, merge, opts = {})
  data, _status_code, _headers = service_tickets_id_merge_post_with_http_info(id, merge, opts)
  return data
end

#service_tickets_id_merge_post_with_http_info(id, merge, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Merge Company

Parameters:

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

    the optional parameters

Returns:

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

    SuccessResponse data, response status code and response headers



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 762

def service_tickets_id_merge_post_with_http_info(id, merge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_merge_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 TicketsApi.service_tickets_id_merge_post"
  end
  # verify the required parameter 'merge' is set
  if @api_client.config.client_side_validation && merge.nil?
    fail ArgumentError, "Missing the required parameter 'merge' when calling TicketsApi.service_tickets_id_merge_post"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/merge".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(merge)
  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 => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_merge_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_patch(id, operations, opts = {}) ⇒ Ticket

Update Ticket

Parameters:

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

    the optional parameters

Returns:



812
813
814
815
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 812

def service_tickets_id_patch(id, operations, opts = {})
  data, _status_code, _headers = service_tickets_id_patch_with_http_info(id, operations, opts)
  return data
end

#service_tickets_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(Ticket, Fixnum, Hash)>

Update Ticket

Parameters:

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

    the optional parameters

Returns:

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

    Ticket data, response status code and response headers



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 823

def service_tickets_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_patch ..."
  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 TicketsApi.service_tickets_id_patch"
  end
  # verify the required parameter 'operations' is set
  if @api_client.config.client_side_validation && operations.nil?
    fail ArgumentError, "Missing the required parameter 'operations' when calling TicketsApi.service_tickets_id_patch"
  end
  # resource path
  local_var_path = "/service/tickets/{id}".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(operations)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Ticket')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Gets the products associated to the ticket /// Please use the /procurement/products/count?conditions=chargeToType='Ticket' AND chargeToId=id endpoint

Parameters:

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

    the optional parameters

Returns:



872
873
874
875
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 872

def service_tickets_id_products_count_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_products_count_get_with_http_info(id, opts)
  return data
end

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

Gets the products associated to the ticket /// Please use the /procurement/products/count?conditions&#x3D;chargeToType&#x3D;&#39;Ticket&#39; AND chargeToId&#x3D;id endpoint

Parameters:

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

    the optional parameters

Returns:

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

    Count data, response status code and response headers



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 882

def service_tickets_id_products_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_products_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 TicketsApi.service_tickets_id_products_count_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/products/count".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'])

  # 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: TicketsApi#service_tickets_id_products_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_products_get(id, opts = {}) ⇒ Array<ProductReference>

Gets the products associated to the ticket /// Please use the /procurement/products?conditions=chargeToType='Ticket' AND chargeToId=id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



927
928
929
930
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 927

def service_tickets_id_products_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_products_get_with_http_info(id, opts)
  return data
end

#service_tickets_id_products_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ProductReference>, Fixnum, Hash)>

Gets the products associated to the ticket /// Please use the /procurement/products?conditions&#x3D;chargeToType&#x3D;&#39;Ticket&#39; AND chargeToId&#x3D;id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 939

def service_tickets_id_products_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_products_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 TicketsApi.service_tickets_id_products_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/products".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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<ProductReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_products_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_put(id, ticket, opts = {}) ⇒ Ticket

Replace Ticket

Parameters:

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

    the optional parameters

Returns:



985
986
987
988
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 985

def service_tickets_id_put(id, ticket, opts = {})
  data, _status_code, _headers = service_tickets_id_put_with_http_info(id, ticket, opts)
  return data
end

#service_tickets_id_put_with_http_info(id, ticket, opts = {}) ⇒ Array<(Ticket, Fixnum, Hash)>

Replace Ticket

Parameters:

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

    the optional parameters

Returns:

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

    Ticket data, response status code and response headers



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 996

def service_tickets_id_put_with_http_info(id, ticket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_put ..."
  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 TicketsApi.service_tickets_id_put"
  end
  # verify the required parameter 'ticket' is set
  if @api_client.config.client_side_validation && ticket.nil?
    fail ArgumentError, "Missing the required parameter 'ticket' when calling TicketsApi.service_tickets_id_put"
  end
  # resource path
  local_var_path = "/service/tickets/{id}".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(ticket)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Ticket')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Gets the schedule entries count associated to the ticket /// Please use the /schedule/entries/count?conditions=type/id=4 AND objectId=id endpoint

Parameters:

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

    the optional parameters

Returns:



1045
1046
1047
1048
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1045

def service_tickets_id_scheduleentries_count_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_scheduleentries_count_get_with_http_info(id, opts)
  return data
end

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

Gets the schedule entries count associated to the ticket /// Please use the /schedule/entries/count?conditions&#x3D;type/id&#x3D;4 AND objectId&#x3D;id endpoint

Parameters:

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

    the optional parameters

Returns:

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

    Count data, response status code and response headers



1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1055

def service_tickets_id_scheduleentries_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_scheduleentries_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 TicketsApi.service_tickets_id_scheduleentries_count_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/scheduleentries/count".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'])

  # 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: TicketsApi#service_tickets_id_scheduleentries_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_scheduleentries_get(id, opts = {}) ⇒ Array<ScheduleEntryReference>

Gets the schedule entries associated to the ticket /// Please use the /schedule/entries?conditions=type/id=4 AND objectId=id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



1100
1101
1102
1103
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1100

def service_tickets_id_scheduleentries_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_scheduleentries_get_with_http_info(id, opts)
  return data
end

#service_tickets_id_scheduleentries_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ScheduleEntryReference>, Fixnum, Hash)>

Gets the schedule entries associated to the ticket /// Please use the /schedule/entries?conditions&#x3D;type/id&#x3D;4 AND objectId&#x3D;id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1112

def service_tickets_id_scheduleentries_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_scheduleentries_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 TicketsApi.service_tickets_id_scheduleentries_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/scheduleentries".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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<ScheduleEntryReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_scheduleentries_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Gets time entries count associated to the ticket /// Please use the /time/entries/count?conditions=(chargeToType="ServiceTicket" OR chargeToType="ProjectTicket") AND chargeToId=id endpoint

Parameters:

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

    the optional parameters

Returns:



1157
1158
1159
1160
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1157

def service_tickets_id_timeentries_count_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_timeentries_count_get_with_http_info(id, opts)
  return data
end

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

Gets time entries count associated to the ticket /// Please use the /time/entries/count?conditions&#x3D;(chargeToType&#x3D;&quot;ServiceTicket&quot; OR chargeToType&#x3D;&quot;ProjectTicket&quot;) AND chargeToId&#x3D;id endpoint

Parameters:

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

    the optional parameters

Returns:

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

    Count data, response status code and response headers



1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1167

def service_tickets_id_timeentries_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_timeentries_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 TicketsApi.service_tickets_id_timeentries_count_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/timeentries/count".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'])

  # 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: TicketsApi#service_tickets_id_timeentries_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_id_timeentries_get(id, opts = {}) ⇒ Array<TimeEntryReference>

Gets time entries associated to the ticket /// Please use the /time/entries?conditions=(chargeToType="ServiceTicket" OR chargeToType="ProjectTicket") AND chargeToId=id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



1212
1213
1214
1215
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1212

def service_tickets_id_timeentries_get(id, opts = {})
  data, _status_code, _headers = service_tickets_id_timeentries_get_with_http_info(id, opts)
  return data
end

#service_tickets_id_timeentries_get_with_http_info(id, opts = {}) ⇒ Array<(Array<TimeEntryReference>, Fixnum, Hash)>

Gets time entries associated to the ticket /// Please use the /time/entries?conditions&#x3D;(chargeToType&#x3D;&quot;ServiceTicket&quot; OR chargeToType&#x3D;&quot;ProjectTicket&quot;) AND chargeToId&#x3D;id endpoint

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1224

def service_tickets_id_timeentries_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_id_timeentries_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 TicketsApi.service_tickets_id_timeentries_get"
  end
  # resource path
  local_var_path = "/service/tickets/{id}/timeentries".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  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<TimeEntryReference>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_id_timeentries_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_post(ticket, opts = {}) ⇒ Ticket

Create Ticket

Parameters:

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

    the optional parameters

Returns:



1269
1270
1271
1272
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1269

def service_tickets_post(ticket, opts = {})
  data, _status_code, _headers = service_tickets_post_with_http_info(ticket, opts)
  return data
end

#service_tickets_post_with_http_info(ticket, opts = {}) ⇒ Array<(Ticket, Fixnum, Hash)>

Create Ticket

Parameters:

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

    the optional parameters

Returns:

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

    Ticket data, response status code and response headers



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1279

def service_tickets_post_with_http_info(ticket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_post ..."
  end
  # verify the required parameter 'ticket' is set
  if @api_client.config.client_side_validation && ticket.nil?
    fail ArgumentError, "Missing the required parameter 'ticket' when calling TicketsApi.service_tickets_post"
  end
  # resource path
  local_var_path = "/service/tickets"

  # 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(ticket)
  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 => 'Ticket')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_tickets_search_post(filter_values, opts = {}) ⇒ Array<Ticket>

Ticket Search

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:



1326
1327
1328
1329
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1326

def service_tickets_search_post(filter_values, opts = {})
  data, _status_code, _headers = service_tickets_search_post_with_http_info(filter_values, opts)
  return data
end

#service_tickets_search_post_with_http_info(filter_values, opts = {}) ⇒ Array<(Array<Ticket>, Fixnum, Hash)>

Ticket Search

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/connectwise-ruby-sdk/api/tickets_api.rb', line 1338

def service_tickets_search_post_with_http_info(filter_values, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TicketsApi.service_tickets_search_post ..."
  end
  # verify the required parameter 'filter_values' is set
  if @api_client.config.client_side_validation && filter_values.nil?
    fail ArgumentError, "Missing the required parameter 'filter_values' when calling TicketsApi.service_tickets_search_post"
  end
  # resource path
  local_var_path = "/service/tickets/search"

  # query parameters
  query_params = {}
  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'])
  # 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(filter_values)
  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 => 'Array<Ticket>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketsApi#service_tickets_search_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end