Class: ConnectWise::WorkflowTriggerOptionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowTriggerOptionsApi

Returns a new instance of WorkflowTriggerOptionsApi.



17
18
19
 
# File 'lib/connect_wise/api/workflow_trigger_options_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_trigger_options_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_system_workflows_by_grandparent_id_triggers_by_parent_id_options(parent_id, grandparent_id, client_id, opts = {}) ⇒ Array<WorkflowTriggerOption>

Get List of WorkflowTriggerOption

Parameters:

  • parent_id (Integer) —

    triggerId

  • grandparent_id (Integer) —

    workflowId

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

    the optional parameters

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)

Returns:



35
36
37
38
 
# File 'lib/connect_wise/api/workflow_trigger_options_api.rb', line 35

def get_system_workflows_by_grandparent_id_triggers_by_parent_id_options(parent_id, grandparent_id, client_id, opts = {})
  data, _status_code, _headers = get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_with_http_info(parent_id, grandparent_id, client_id, opts)
  data
end

#get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count(parent_id, grandparent_id, client_id, opts = {}) ⇒ Count

Get Count of WorkflowTriggerOption

Parameters:

  • parent_id (Integer) —

    triggerId

  • grandparent_id (Integer) —

    workflowId

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

    the optional parameters

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)

Returns:



124
125
126
127
 
# File 'lib/connect_wise/api/workflow_trigger_options_api.rb', line 124

def get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count(parent_id, grandparent_id, client_id, opts = {})
  data, _status_code, _headers = get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count_with_http_info(parent_id, grandparent_id, client_id, opts)
  data
end

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

Get Count of WorkflowTriggerOption

Parameters:

  • parent_id (Integer) —

    triggerId

  • grandparent_id (Integer) —

    workflowId

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

    the optional parameters

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)

Returns:

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

    Count data, response status code and response headers

Raises:

  • (ArgumentError) 


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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/connect_wise/api/workflow_trigger_options_api.rb', line 143

def get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count_with_http_info(parent_id, grandparent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count" 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 WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count" 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 WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/system/workflows/{grandparentId}/triggers/{parentId}/options/count'.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] || 'Count'

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

  new_options = opts.merge(
    operation: :'WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count',
    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: WorkflowTriggerOptionsApi#get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

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

Get List of WorkflowTriggerOption

Parameters:

  • parent_id (Integer) —

    triggerId

  • grandparent_id (Integer) —

    workflowId

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

    the optional parameters

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)

Returns:

  • (Array<(Array<WorkflowTriggerOption>, Integer, Hash)>) —

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

Raises:

  • (ArgumentError) 


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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/connect_wise/api/workflow_trigger_options_api.rb', line 54

def get_system_workflows_by_grandparent_id_triggers_by_parent_id_options_with_http_info(parent_id, grandparent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options" 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 WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options" 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 WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/system/workflows/{grandparentId}/triggers/{parentId}/options'.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<WorkflowTriggerOption>'

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

  new_options = opts.merge(
    operation: :'WorkflowTriggerOptionsApi.get_system_workflows_by_grandparent_id_triggers_by_parent_id_options',
    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: WorkflowTriggerOptionsApi#get_system_workflows_by_grandparent_id_triggers_by_parent_id_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end