Class: ConnectWise::WorkflowsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowsApi

Returns a new instance of WorkflowsApi.



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

def api_client
  @api_client
end

Instance Method Details

#system_workflows_count_get(opts = {}) ⇒ Count

Get Workflows Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def system_workflows_count_get(opts = {})
  data, _status_code, _headers = system_workflows_count_get_with_http_info(opts)
  return data
end

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

Get Workflows Count

Parameters:

  • 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



27
28
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
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 27

def system_workflows_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_count_get ..."
  end
  # resource path
  local_var_path = "/system/workflows/count"

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

#system_workflows_get(opts = {}) ⇒ Array<Workflow>

Get Workflows

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:



72
73
74
75
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 72

def system_workflows_get(opts = {})
  data, _status_code, _headers = system_workflows_get_with_http_info(opts)
  return data
end

#system_workflows_get_with_http_info(opts = {}) ⇒ Array<(Array<Workflow>, Fixnum, Hash)>

Get Workflows

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

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



87
88
89
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
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 87

def system_workflows_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_get ..."
  end
  # resource path
  local_var_path = "/system/workflows"

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

#system_workflows_id_copy_post(id, opts = {}) ⇒ Workflow

Copy Workflow

Parameters:

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

    the optional parameters

Returns:



132
133
134
135
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 132

def system_workflows_id_copy_post(id, opts = {})
  data, _status_code, _headers = system_workflows_id_copy_post_with_http_info(id, opts)
  return data
end

#system_workflows_id_copy_post_with_http_info(id, opts = {}) ⇒ Array<(Workflow, Fixnum, Hash)>

Copy Workflow

Parameters:

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

    the optional parameters

Returns:

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

    Workflow data, response status code and response headers



142
143
144
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
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 142

def system_workflows_id_copy_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_id_copy_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 WorkflowsApi.system_workflows_id_copy_post"
  end
  # resource path
  local_var_path = "/system/workflows/{id}/copy".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(: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 => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#system_workflows_id_copy_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Workflow By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


185
186
187
188
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 185

def system_workflows_id_delete(id, opts = {})
  system_workflows_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Workflow By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



195
196
197
198
199
200
201
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
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 195

def system_workflows_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_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 WorkflowsApi.system_workflows_id_delete"
  end
  # resource path
  local_var_path = "/system/workflows/{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: WorkflowsApi#system_workflows_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_workflows_id_get(id, opts = {}) ⇒ Workflow

Get Workflow By Id

Parameters:

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

    the optional parameters

Returns:



235
236
237
238
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 235

def system_workflows_id_get(id, opts = {})
  data, _status_code, _headers = system_workflows_id_get_with_http_info(id, opts)
  return data
end

#system_workflows_id_get_with_http_info(id, opts = {}) ⇒ Array<(Workflow, Fixnum, Hash)>

Get Workflow By Id

Parameters:

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

    the optional parameters

Returns:

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

    Workflow data, response status code and response headers



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 245

def system_workflows_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_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 WorkflowsApi.system_workflows_id_get"
  end
  # resource path
  local_var_path = "/system/workflows/{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 => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#system_workflows_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_workflows_id_patch(id, operations, opts = {}) ⇒ Workflow

Update Workflow

Parameters:

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

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 289

def system_workflows_id_patch(id, operations, opts = {})
  data, _status_code, _headers = system_workflows_id_patch_with_http_info(id, operations, opts)
  return data
end

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

Update Workflow

Parameters:

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

    the optional parameters

Returns:

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

    Workflow data, response status code and response headers



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
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
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 300

def system_workflows_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_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 WorkflowsApi.system_workflows_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 WorkflowsApi.system_workflows_id_patch"
  end
  # resource path
  local_var_path = "/system/workflows/{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 => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#system_workflows_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_workflows_id_put(id, workflow, opts = {}) ⇒ Workflow

Replace Workflow

Parameters:

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

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 350

def system_workflows_id_put(id, workflow, opts = {})
  data, _status_code, _headers = system_workflows_id_put_with_http_info(id, workflow, opts)
  return data
end

#system_workflows_id_put_with_http_info(id, workflow, opts = {}) ⇒ Array<(Workflow, Fixnum, Hash)>

Replace Workflow

Parameters:

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

    the optional parameters

Returns:

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

    Workflow data, response status code and response headers



361
362
363
364
365
366
367
368
369
370
371
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
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 361

def system_workflows_id_put_with_http_info(id, workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_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 WorkflowsApi.system_workflows_id_put"
  end
  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowsApi.system_workflows_id_put"
  end
  # resource path
  local_var_path = "/system/workflows/{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(workflow)
  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 => 'Workflow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowsApi#system_workflows_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_workflows_post(workflow, opts = {}) ⇒ Workflow

Create Workflow

Parameters:

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

    the optional parameters

Returns:



410
411
412
413
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 410

def system_workflows_post(workflow, opts = {})
  data, _status_code, _headers = system_workflows_post_with_http_info(workflow, opts)
  return data
end

#system_workflows_post_with_http_info(workflow, opts = {}) ⇒ Array<(Workflow, Fixnum, Hash)>

Create Workflow

Parameters:

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

    the optional parameters

Returns:

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

    Workflow data, response status code and response headers



420
421
422
423
424
425
426
427
428
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
 
# File 'lib/connectwise-ruby-sdk/api/workflows_api.rb', line 420

def system_workflows_post_with_http_info(workflow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowsApi.system_workflows_post ..."
  end
  # verify the required parameter 'workflow' is set
  if @api_client.config.client_side_validation && workflow.nil?
    fail ArgumentError, "Missing the required parameter 'workflow' when calling WorkflowsApi.system_workflows_post"
  end
  # resource path
  local_var_path = "/system/workflows"

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