Class: ConnectWise::WorkflowTriggerOptionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/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.



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

def api_client
  @api_client
end

Instance Method Details

#system_workflows_workflow_id_triggers_trigger_id_options_count_get(workflow_id, trigger_id, opts = {}) ⇒ Count

Get Workflow Triggers Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def system_workflows_workflow_id_triggers_trigger_id_options_count_get(workflow_id, trigger_id, opts = {})
  data, _status_code, _headers = system_workflows_workflow_id_triggers_trigger_id_options_count_get_with_http_info(workflow_id, trigger_id, opts)
  return data
end

#system_workflows_workflow_id_triggers_trigger_id_options_count_get_with_http_info(workflow_id, trigger_id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Workflow Triggers Count

Parameters:

  • workflow_id
  • trigger_id
  • 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



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
67
68
69
70
71
72
 
# File 'lib/connectwise-ruby-sdk/api/workflow_trigger_options_api.rb', line 31

def system_workflows_workflow_id_triggers_trigger_id_options_count_get_with_http_info(workflow_id, trigger_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowTriggerOptionsApi.system_workflows_workflow_id_triggers_trigger_id_options_count_get ..."
  end
  # verify the required parameter 'workflow_id' is set
  if @api_client.config.client_side_validation && workflow_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_id' when calling WorkflowTriggerOptionsApi.system_workflows_workflow_id_triggers_trigger_id_options_count_get"
  end
  # verify the required parameter 'trigger_id' is set
  if @api_client.config.client_side_validation && trigger_id.nil?
    fail ArgumentError, "Missing the required parameter 'trigger_id' when calling WorkflowTriggerOptionsApi.system_workflows_workflow_id_triggers_trigger_id_options_count_get"
  end
  # resource path
  local_var_path = "/system/workflows/{workflowId}/triggers/{triggerId}/options/count".sub('{' + 'workflowId' + '}', workflow_id.to_s).sub('{' + 'triggerId' + '}', trigger_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: WorkflowTriggerOptionsApi#system_workflows_workflow_id_triggers_trigger_id_options_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_workflows_workflow_id_triggers_trigger_id_options_get(workflow_id, trigger_id, opts = {}) ⇒ Array<WorkflowTriggerOption>

Get Trigger Options

Parameters:

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



86
87
88
89
 
# File 'lib/connectwise-ruby-sdk/api/workflow_trigger_options_api.rb', line 86

def system_workflows_workflow_id_triggers_trigger_id_options_get(workflow_id, trigger_id, opts = {})
  data, _status_code, _headers = system_workflows_workflow_id_triggers_trigger_id_options_get_with_http_info(workflow_id, trigger_id, opts)
  return data
end

#system_workflows_workflow_id_triggers_trigger_id_options_get_with_http_info(workflow_id, trigger_id, opts = {}) ⇒ Array<(Array<WorkflowTriggerOption>, Fixnum, Hash)>

Get Trigger Options

Parameters:

  • workflow_id
  • trigger_id
  • 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<WorkflowTriggerOption>, Fixnum, Hash)>) —

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



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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/connectwise-ruby-sdk/api/workflow_trigger_options_api.rb', line 103

def system_workflows_workflow_id_triggers_trigger_id_options_get_with_http_info(workflow_id, trigger_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WorkflowTriggerOptionsApi.system_workflows_workflow_id_triggers_trigger_id_options_get ..."
  end
  # verify the required parameter 'workflow_id' is set
  if @api_client.config.client_side_validation && workflow_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_id' when calling WorkflowTriggerOptionsApi.system_workflows_workflow_id_triggers_trigger_id_options_get"
  end
  # verify the required parameter 'trigger_id' is set
  if @api_client.config.client_side_validation && trigger_id.nil?
    fail ArgumentError, "Missing the required parameter 'trigger_id' when calling WorkflowTriggerOptionsApi.system_workflows_workflow_id_triggers_trigger_id_options_get"
  end
  # resource path
  local_var_path = "/system/workflows/{workflowId}/triggers/{triggerId}/options".sub('{' + 'workflowId' + '}', workflow_id.to_s).sub('{' + 'triggerId' + '}', trigger_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<WorkflowTriggerOption>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowTriggerOptionsApi#system_workflows_workflow_id_triggers_trigger_id_options_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end