Class: EmbedWorkflow::DataFieldsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/embed_workflow/api/data_fields_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataFieldsApi

Returns a new instance of DataFieldsApi.



19
20
21
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#evaluate_expression(expression:, data:, **opts) ⇒ EvaluateExpression200Response

Evaluate expression

Parameters:

  • opts (Hash) —

    the optional parameters

  • expression (String) —

    Liquid template expression to evaluate against the provided data

  • data (Hash<String, Object>) —

    Data context for evaluating the expression

Returns:



27
28
29
30
31
32
33
34
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 27

def evaluate_expression(expression:, data:, **opts)
  opts[:'evaluate_expression_request'] = EvaluateExpressionRequest.new(
    expression: expression,
    data: data,
  )
  data, _status_code, _headers = evaluate_expression_with_http_info(opts)
  data
end

#evaluate_expression_with_http_info(opts = {}) ⇒ Array<(EvaluateExpression200Response, Integer, Hash)>

Evaluate expression

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
79
80
81
82
83
84
85
86
87
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 40

def evaluate_expression_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataFieldsApi.evaluate_expression ...'
  end
  # resource path
  local_var_path = '/api/v1/data_fields/evaluate'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"DataFieldsApi.evaluate_expression",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataFieldsApi#evaluate_expression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_data_fields(**opts) ⇒ ListDataFields200Response

List data fields

Parameters:

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :user_key (String) —

    Filter results by user key

  • :event_trigger (String) —

    Filter results by event trigger

  • :type (ListDataFieldsTypeParameter) —

    Data type filter - can be a single type or multiple types

Returns:



95
96
97
98
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 95

def list_data_fields(**opts)
  data, _status_code, _headers = list_data_fields_with_http_info(opts)
  data
end

#list_data_fields_with_http_info(opts = {}) ⇒ Array<(ListDataFields200Response, Integer, Hash)>

List data fields

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_key (String) —

    Filter results by user key

  • :event_trigger (String) —

    Filter results by event trigger

  • :type (ListDataFieldsTypeParameter) —

    Data type filter - can be a single type or multiple types

Returns:

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

    ListDataFields200Response data, response status code and response headers



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
150
151
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 106

def list_data_fields_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataFieldsApi.list_data_fields ...'
  end
  # resource path
  local_var_path = '/api/v1/data_fields'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_key'] = opts[:'user_key'] if !opts[:'user_key'].nil?
  query_params[:'event_trigger'] = opts[:'event_trigger'] if !opts[:'event_trigger'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"DataFieldsApi.list_data_fields",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataFieldsApi#list_data_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_workflow_data_fields(id:, **opts) ⇒ ListDataFields200Response

List workflow data fields

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :node_id (String) —

    Node ID to determine current workflow position

  • :parent_node_id (String) —

    Parent node ID to determine workflow position

  • :user_key (String) —

    User context for determining available data fields

  • :event_trigger (String) —

    Event trigger context for determining available data fields

  • :action_event_trigger (String) —

    Action&#39;s event trigger context for determining available data fields

  • :type (ListDataFieldsTypeParameter) —

    Data type filter - can be a single type or multiple types

Returns:



163
164
165
166
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 163

def list_workflow_data_fields(id:, **opts)
  data, _status_code, _headers = list_workflow_data_fields_with_http_info(id, opts)
  data
end

#list_workflow_data_fields_with_http_info(id, opts = {}) ⇒ Array<(ListDataFields200Response, Integer, Hash)>

List workflow data fields

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Options Hash (opts):

  • :node_id (String) —

    Node ID to determine current workflow position

  • :parent_node_id (String) —

    Parent node ID to determine workflow position

  • :user_key (String) —

    User context for determining available data fields

  • :event_trigger (String) —

    Event trigger context for determining available data fields

  • :action_event_trigger (String) —

    Action&#39;s event trigger context for determining available data fields

  • :type (ListDataFieldsTypeParameter) —

    Data type filter - can be a single type or multiple types

Returns:

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

    ListDataFields200Response data, response status code and response headers



178
179
180
181
182
183
184
185
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
 
# File 'lib/embed_workflow/api/data_fields_api.rb', line 178

def list_workflow_data_fields_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataFieldsApi.list_workflow_data_fields ...'
  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 DataFieldsApi.list_workflow_data_fields"
  end
  # resource path
  local_var_path = '/api/v1/workflows/{id}/data_fields'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'node_id'] = opts[:'node_id'] if !opts[:'node_id'].nil?
  query_params[:'parent_node_id'] = opts[:'parent_node_id'] if !opts[:'parent_node_id'].nil?
  query_params[:'user_key'] = opts[:'user_key'] if !opts[:'user_key'].nil?
  query_params[:'event_trigger'] = opts[:'event_trigger'] if !opts[:'event_trigger'].nil?
  query_params[:'action_event_trigger'] = opts[:'action_event_trigger'] if !opts[:'action_event_trigger'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"DataFieldsApi.list_workflow_data_fields",
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataFieldsApi#list_workflow_data_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end