Class: ConnectWise::WorkflowActionUserDefinedFieldsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/workflow_action_user_defined_fields_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowActionUserDefinedFieldsApi 



17
18
19
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#delete_system_workflows_userdefinedfields_actions_by_parent_id(parent_id, client_id, opts = {}) ⇒ nil

Delete WorkflowActionUserDefinedField



26
27
28
29
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 26

def delete_system_workflows_userdefinedfields_actions_by_parent_id(parent_id, client_id, opts = {})
  delete_system_workflows_userdefinedfields_actions_by_parent_id_with_http_info(parent_id, client_id, opts)
  nil
end

#delete_system_workflows_userdefinedfields_actions_by_parent_id_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete WorkflowActionUserDefinedField

Raises:

  • (ArgumentError) 


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
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 36

def delete_system_workflows_userdefinedfields_actions_by_parent_id_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: WorkflowActionUserDefinedFieldsApi.delete_system_workflows_userdefinedfields_actions_by_parent_id ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling WorkflowActionUserDefinedFieldsApi.delete_system_workflows_userdefinedfields_actions_by_parent_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling WorkflowActionUserDefinedFieldsApi.delete_system_workflows_userdefinedfields_actions_by_parent_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/system/workflows/userdefinedfields/actions/{parentId}'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'WorkflowActionUserDefinedFieldsApi.delete_system_workflows_userdefinedfields_actions_by_parent_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  @api_client.config.logger.debug "API called: WorkflowActionUserDefinedFieldsApi#delete_system_workflows_userdefinedfields_actions_by_parent_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id(parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<WorkflowActionUserDefinedField>

Get List of WorkflowActionUserDefinedField

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer) 


94
95
96
97
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 94

def get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id(parent_id, grandparent_id, client_id, opts = {})
  data, _status_code, _headers = get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id_with_http_info(parent_id, grandparent_id, client_id, opts)
  data
end

#get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id_with_http_info(parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<(Array<WorkflowActionUserDefinedField>, Integer, Hash)>

Get List of WorkflowActionUserDefinedField

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Raises:

  • (ArgumentError) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 113

def get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id_with_http_info(parent_id, grandparent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: WorkflowActionUserDefinedFieldsApi.get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling WorkflowActionUserDefinedFieldsApi.get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling WorkflowActionUserDefinedFieldsApi.get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling WorkflowActionUserDefinedFieldsApi.get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/system/workflows/userdefinedfields/events{grandparentId}/actions/{parentId}'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<WorkflowActionUserDefinedField>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'WorkflowActionUserDefinedFieldsApi.get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: WorkflowActionUserDefinedFieldsApi#get_system_workflows_userdefinedfields_by_grandparent_id_actions_by_parent_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#patch_system_workflows_userdefinedfields_by_id(id, client_id, patch_operation, opts = {}) ⇒ WorkflowActionUserDefinedField

Patch WorkflowActionUserDefinedField



175
176
177
178
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 175

def patch_system_workflows_userdefinedfields_by_id(id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_system_workflows_userdefinedfields_by_id_with_http_info(id, client_id, patch_operation, opts)
  data
end

#patch_system_workflows_userdefinedfields_by_id_with_http_info(id, client_id, patch_operation, opts = {}) ⇒ Array<(WorkflowActionUserDefinedField, Integer, Hash)>

Patch WorkflowActionUserDefinedField

Raises:

  • (ArgumentError) 


186
187
188
189
190
191
192
193
194
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
229
230
231
232
233
234
235
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 186

def patch_system_workflows_userdefinedfields_by_id_with_http_info(id, client_id, patch_operation, opts = {})
  @api_client.config.logger.debug 'Calling API: WorkflowActionUserDefinedFieldsApi.patch_system_workflows_userdefinedfields_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling WorkflowActionUserDefinedFieldsApi.patch_system_workflows_userdefinedfields_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling WorkflowActionUserDefinedFieldsApi.patch_system_workflows_userdefinedfields_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'patch_operation' is set
  raise ArgumentError, "Missing the required parameter 'patch_operation' when calling WorkflowActionUserDefinedFieldsApi.patch_system_workflows_userdefinedfields_by_id" if @api_client.config.client_side_validation && patch_operation.nil?

  # resource path
  local_var_path = '/system/workflows/userdefinedfields/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)

  # return_type
  return_type = opts[:debug_return_type] || 'WorkflowActionUserDefinedField'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'WorkflowActionUserDefinedFieldsApi.patch_system_workflows_userdefinedfields_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  @api_client.config.logger.debug "API called: WorkflowActionUserDefinedFieldsApi#patch_system_workflows_userdefinedfields_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_system_workflows_userdefinedfields_events_by_grandparent_id(grandparent_id, client_id, workflow_action_user_defined_field, opts = {}) ⇒ WorkflowActionUserDefinedField

Post WorkflowActionUserDefinedField



243
244
245
246
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 243

def post_system_workflows_userdefinedfields_events_by_grandparent_id(grandparent_id, client_id, workflow_action_user_defined_field, opts = {})
  data, _status_code, _headers = post_system_workflows_userdefinedfields_events_by_grandparent_id_with_http_info(grandparent_id, client_id, workflow_action_user_defined_field, opts)
  data
end

#post_system_workflows_userdefinedfields_events_by_grandparent_id_with_http_info(grandparent_id, client_id, workflow_action_user_defined_field, opts = {}) ⇒ Array<(WorkflowActionUserDefinedField, Integer, Hash)>

Post WorkflowActionUserDefinedField

Raises:

  • (ArgumentError) 


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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 254

def post_system_workflows_userdefinedfields_events_by_grandparent_id_with_http_info(grandparent_id, client_id, workflow_action_user_defined_field, opts = {})
  @api_client.config.logger.debug 'Calling API: WorkflowActionUserDefinedFieldsApi.post_system_workflows_userdefinedfields_events_by_grandparent_id ...' if @api_client.config.debugging
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling WorkflowActionUserDefinedFieldsApi.post_system_workflows_userdefinedfields_events_by_grandparent_id" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling WorkflowActionUserDefinedFieldsApi.post_system_workflows_userdefinedfields_events_by_grandparent_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'workflow_action_user_defined_field' is set
  raise ArgumentError, "Missing the required parameter 'workflow_action_user_defined_field' when calling WorkflowActionUserDefinedFieldsApi.post_system_workflows_userdefinedfields_events_by_grandparent_id" if @api_client.config.client_side_validation && workflow_action_user_defined_field.nil?

  # resource path
  local_var_path = '/system/workflows/userdefinedfields/events/{grandparentId}'.sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(workflow_action_user_defined_field)

  # return_type
  return_type = opts[:debug_return_type] || 'WorkflowActionUserDefinedField'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'WorkflowActionUserDefinedFieldsApi.post_system_workflows_userdefinedfields_events_by_grandparent_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: WorkflowActionUserDefinedFieldsApi#post_system_workflows_userdefinedfields_events_by_grandparent_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_system_workflows_userdefinedfields_by_id(id, client_id, workflow_action_user_defined_field, opts = {}) ⇒ WorkflowActionUserDefinedField

Put WorkflowActionUserDefinedField



311
312
313
314
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 311

def put_system_workflows_userdefinedfields_by_id(id, client_id, workflow_action_user_defined_field, opts = {})
  data, _status_code, _headers = put_system_workflows_userdefinedfields_by_id_with_http_info(id, client_id, workflow_action_user_defined_field, opts)
  data
end

#put_system_workflows_userdefinedfields_by_id_with_http_info(id, client_id, workflow_action_user_defined_field, opts = {}) ⇒ Array<(WorkflowActionUserDefinedField, Integer, Hash)>

Put WorkflowActionUserDefinedField

Raises:

  • (ArgumentError) 


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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/connect_wise/api/workflow_action_user_defined_fields_api.rb', line 322

def put_system_workflows_userdefinedfields_by_id_with_http_info(id, client_id, workflow_action_user_defined_field, opts = {})
  @api_client.config.logger.debug 'Calling API: WorkflowActionUserDefinedFieldsApi.put_system_workflows_userdefinedfields_by_id ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling WorkflowActionUserDefinedFieldsApi.put_system_workflows_userdefinedfields_by_id" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling WorkflowActionUserDefinedFieldsApi.put_system_workflows_userdefinedfields_by_id" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'workflow_action_user_defined_field' is set
  raise ArgumentError, "Missing the required parameter 'workflow_action_user_defined_field' when calling WorkflowActionUserDefinedFieldsApi.put_system_workflows_userdefinedfields_by_id" if @api_client.config.client_side_validation && workflow_action_user_defined_field.nil?

  # resource path
  local_var_path = '/system/workflows/userdefinedfields/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(workflow_action_user_defined_field)

  # return_type
  return_type = opts[:debug_return_type] || 'WorkflowActionUserDefinedField'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'WorkflowActionUserDefinedFieldsApi.put_system_workflows_userdefinedfields_by_id',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  @api_client.config.logger.debug "API called: WorkflowActionUserDefinedFieldsApi#put_system_workflows_userdefinedfields_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end