Class: ConnectWise::WorkflowEventsApi
- Inherits:
-
Object
- Object
- ConnectWise::WorkflowEventsApi
- Defined in:
- lib/connectwise-ruby-sdk/api/workflow_events_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ WorkflowEventsApi
constructor
A new instance of WorkflowEventsApi.
-
#system_workflows_id_events_count_get(id, opts = {}) ⇒ Count
Get Workflow Events Count.
-
#system_workflows_id_events_count_get_with_http_info(id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>
Get Workflow Events Count.
-
#system_workflows_id_events_event_id_delete(id, event_id, opts = {}) ⇒ nil
Delete Workflow Event By Id.
-
#system_workflows_id_events_event_id_delete_with_http_info(id, event_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete Workflow Event By Id.
-
#system_workflows_id_events_event_id_get(id, event_id, opts = {}) ⇒ WorkflowEvent
Get Workflow Event By Id.
-
#system_workflows_id_events_event_id_get_with_http_info(id, event_id, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Get Workflow Event By Id.
-
#system_workflows_id_events_event_id_patch(id, event_id, operations, opts = {}) ⇒ WorkflowEvent
Update Workflow Event.
-
#system_workflows_id_events_event_id_patch_with_http_info(id, event_id, operations, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Update Workflow Event.
-
#system_workflows_id_events_event_id_put(id, event_id, workflow_event, opts = {}) ⇒ WorkflowEvent
Replace Workflow Event.
-
#system_workflows_id_events_event_id_put_with_http_info(id, event_id, workflow_event, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Replace Workflow Event.
-
#system_workflows_id_events_event_id_test_get(id, event_id, opts = {}) ⇒ JArray
Test Workflow Evemt.
-
#system_workflows_id_events_event_id_test_get_with_http_info(id, event_id, opts = {}) ⇒ Array<(JArray, Fixnum, Hash)>
Test Workflow Evemt.
-
#system_workflows_id_events_get(id, opts = {}) ⇒ Array<WorkflowEvent>
Get Workflow Events.
-
#system_workflows_id_events_get_with_http_info(id, opts = {}) ⇒ Array<(Array<WorkflowEvent>, Fixnum, Hash)>
Get Workflow Events.
-
#system_workflows_id_events_post(id, workflow_event, opts = {}) ⇒ WorkflowEvent
Create Workflow Event.
-
#system_workflows_id_events_post_with_http_info(id, workflow_event, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Create Workflow Event.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ WorkflowEventsApi
Returns a new instance of WorkflowEventsApi.
8 9 10 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_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/workflow_events_api.rb', line 6 def api_client @api_client end |
Instance Method Details
#system_workflows_id_events_count_get(id, opts = {}) ⇒ Count
Get Workflow Events Count
18 19 20 21 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 18 def system_workflows_id_events_count_get(id, opts = {}) data, _status_code, _headers = system_workflows_id_events_count_get_with_http_info(id, opts) return data end |
#system_workflows_id_events_count_get_with_http_info(id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>
Get Workflow Events Count
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/workflow_events_api.rb', line 29 def system_workflows_id_events_count_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_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 WorkflowEventsApi.system_workflows_id_events_count_get" end # resource path local_var_path = "/system/workflows/{id}/events/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: WorkflowEventsApi#system_workflows_id_events_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_workflows_id_events_event_id_delete(id, event_id, opts = {}) ⇒ nil
Delete Workflow Event By Id
74 75 76 77 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 74 def system_workflows_id_events_event_id_delete(id, event_id, opts = {}) system_workflows_id_events_event_id_delete_with_http_info(id, event_id, opts) return nil end |
#system_workflows_id_events_event_id_delete_with_http_info(id, event_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete Workflow Event By Id
85 86 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 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 85 def system_workflows_id_events_event_id_delete_with_http_info(id, event_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_event_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 WorkflowEventsApi.system_workflows_id_events_event_id_delete" end # verify the required parameter 'event_id' is set if @api_client.config.client_side_validation && event_id.nil? fail ArgumentError, "Missing the required parameter 'event_id' when calling WorkflowEventsApi.system_workflows_id_events_event_id_delete" end # resource path local_var_path = "/system/workflows/{id}/events/{eventId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'eventId' + '}', event_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: WorkflowEventsApi#system_workflows_id_events_event_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_workflows_id_events_event_id_get(id, event_id, opts = {}) ⇒ WorkflowEvent
Get Workflow Event By Id
130 131 132 133 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 130 def system_workflows_id_events_event_id_get(id, event_id, opts = {}) data, _status_code, _headers = system_workflows_id_events_event_id_get_with_http_info(id, event_id, opts) return data end |
#system_workflows_id_events_event_id_get_with_http_info(id, event_id, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Get Workflow Event By Id
141 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 179 180 181 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 141 def system_workflows_id_events_event_id_get_with_http_info(id, event_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_event_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 WorkflowEventsApi.system_workflows_id_events_event_id_get" end # verify the required parameter 'event_id' is set if @api_client.config.client_side_validation && event_id.nil? fail ArgumentError, "Missing the required parameter 'event_id' when calling WorkflowEventsApi.system_workflows_id_events_event_id_get" end # resource path local_var_path = "/system/workflows/{id}/events/{eventId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'eventId' + '}', event_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 => 'WorkflowEvent') if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkflowEventsApi#system_workflows_id_events_event_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_workflows_id_events_event_id_patch(id, event_id, operations, opts = {}) ⇒ WorkflowEvent
Update Workflow Event
190 191 192 193 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 190 def system_workflows_id_events_event_id_patch(id, event_id, operations, opts = {}) data, _status_code, _headers = system_workflows_id_events_event_id_patch_with_http_info(id, event_id, operations, opts) return data end |
#system_workflows_id_events_event_id_patch_with_http_info(id, event_id, operations, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Update Workflow Event
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 241 242 243 244 245 246 247 248 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 202 def system_workflows_id_events_event_id_patch_with_http_info(id, event_id, operations, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_event_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 WorkflowEventsApi.system_workflows_id_events_event_id_patch" end # verify the required parameter 'event_id' is set if @api_client.config.client_side_validation && event_id.nil? fail ArgumentError, "Missing the required parameter 'event_id' when calling WorkflowEventsApi.system_workflows_id_events_event_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 WorkflowEventsApi.system_workflows_id_events_event_id_patch" end # resource path local_var_path = "/system/workflows/{id}/events/{eventId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'eventId' + '}', event_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 => 'WorkflowEvent') if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkflowEventsApi#system_workflows_id_events_event_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_workflows_id_events_event_id_put(id, event_id, workflow_event, opts = {}) ⇒ WorkflowEvent
Replace Workflow Event
257 258 259 260 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 257 def system_workflows_id_events_event_id_put(id, event_id, workflow_event, opts = {}) data, _status_code, _headers = system_workflows_id_events_event_id_put_with_http_info(id, event_id, workflow_event, opts) return data end |
#system_workflows_id_events_event_id_put_with_http_info(id, event_id, workflow_event, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Replace Workflow Event
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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 269 def system_workflows_id_events_event_id_put_with_http_info(id, event_id, workflow_event, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_event_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 WorkflowEventsApi.system_workflows_id_events_event_id_put" end # verify the required parameter 'event_id' is set if @api_client.config.client_side_validation && event_id.nil? fail ArgumentError, "Missing the required parameter 'event_id' when calling WorkflowEventsApi.system_workflows_id_events_event_id_put" end # verify the required parameter 'workflow_event' is set if @api_client.config.client_side_validation && workflow_event.nil? fail ArgumentError, "Missing the required parameter 'workflow_event' when calling WorkflowEventsApi.system_workflows_id_events_event_id_put" end # resource path local_var_path = "/system/workflows/{id}/events/{eventId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'eventId' + '}', event_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_event) 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 => 'WorkflowEvent') if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkflowEventsApi#system_workflows_id_events_event_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_workflows_id_events_event_id_test_get(id, event_id, opts = {}) ⇒ JArray
Test Workflow Evemt
323 324 325 326 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 323 def system_workflows_id_events_event_id_test_get(id, event_id, opts = {}) data, _status_code, _headers = system_workflows_id_events_event_id_test_get_with_http_info(id, event_id, opts) return data end |
#system_workflows_id_events_event_id_test_get_with_http_info(id, event_id, opts = {}) ⇒ Array<(JArray, Fixnum, Hash)>
Test Workflow Evemt
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 334 def system_workflows_id_events_event_id_test_get_with_http_info(id, event_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_event_id_test_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 WorkflowEventsApi.system_workflows_id_events_event_id_test_get" end # verify the required parameter 'event_id' is set if @api_client.config.client_side_validation && event_id.nil? fail ArgumentError, "Missing the required parameter 'event_id' when calling WorkflowEventsApi.system_workflows_id_events_event_id_test_get" end # resource path local_var_path = "/system/workflows/{id}/events/{eventId}/test".sub('{' + 'id' + '}', id.to_s).sub('{' + 'eventId' + '}', event_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 => 'JArray') if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkflowEventsApi#system_workflows_id_events_event_id_test_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_workflows_id_events_get(id, opts = {}) ⇒ Array<WorkflowEvent>
Get Workflow Events
387 388 389 390 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 387 def system_workflows_id_events_get(id, opts = {}) data, _status_code, _headers = system_workflows_id_events_get_with_http_info(id, opts) return data end |
#system_workflows_id_events_get_with_http_info(id, opts = {}) ⇒ Array<(Array<WorkflowEvent>, Fixnum, Hash)>
Get Workflow Events
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 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 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 403 def system_workflows_id_events_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_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 WorkflowEventsApi.system_workflows_id_events_get" end # resource path local_var_path = "/system/workflows/{id}/events".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<WorkflowEvent>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkflowEventsApi#system_workflows_id_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_workflows_id_events_post(id, workflow_event, opts = {}) ⇒ WorkflowEvent
Create Workflow Event
453 454 455 456 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 453 def system_workflows_id_events_post(id, workflow_event, opts = {}) data, _status_code, _headers = system_workflows_id_events_post_with_http_info(id, workflow_event, opts) return data end |
#system_workflows_id_events_post_with_http_info(id, workflow_event, opts = {}) ⇒ Array<(WorkflowEvent, Fixnum, Hash)>
Create Workflow Event
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 |
# File 'lib/connectwise-ruby-sdk/api/workflow_events_api.rb', line 464 def system_workflows_id_events_post_with_http_info(id, workflow_event, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WorkflowEventsApi.system_workflows_id_events_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 WorkflowEventsApi.system_workflows_id_events_post" end # verify the required parameter 'workflow_event' is set if @api_client.config.client_side_validation && workflow_event.nil? fail ArgumentError, "Missing the required parameter 'workflow_event' when calling WorkflowEventsApi.system_workflows_id_events_post" end # resource path local_var_path = "/system/workflows/{id}/events".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_event) 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 => 'WorkflowEvent') if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkflowEventsApi#system_workflows_id_events_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |