Class: EmbedWorkflow::ExecutionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExecutionsApi

Returns a new instance of ExecutionsApi.



19
20
21
 
# File 'lib/embed_workflow/api/executions_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/executions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_workflow_executions(workflow_id:, **opts) ⇒ ListWorkflowExecutions200Response

List workflow executions

Parameters:

  • workflow_id (String) —

    Filter results by workflow id

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :starting_after (String) —

    Cursor for pagination - return results after this ID

  • :ending_before (String) —

    Cursor for pagination - return results before this ID

  • :limit (Integer) —

    Number of items to return (max 100)

Returns:



29
30
31
32
 
# File 'lib/embed_workflow/api/executions_api.rb', line 29

def list_workflow_executions(workflow_id:, **opts)
  data, _status_code, _headers = list_workflow_executions_with_http_info(workflow_id, opts)
  data
end

#list_workflow_executions_with_http_info(workflow_id, opts = {}) ⇒ Array<(ListWorkflowExecutions200Response, Integer, Hash)>

List workflow executions

Parameters:

  • workflow_id (String) —

    Filter results by workflow id

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

    the optional parameters

Options Hash (opts):

  • :starting_after (String) —

    Cursor for pagination - return results after this ID

  • :ending_before (String) —

    Cursor for pagination - return results before this ID

  • :limit (Integer) —

    Number of items to return (max 100)

Returns:



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
88
89
90
 
# File 'lib/embed_workflow/api/executions_api.rb', line 41

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'ListWorkflowExecutions200Response'

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

  new_options = opts.merge(
    :operation => :"ExecutionsApi.list_workflow_executions",
    :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: ExecutionsApi#list_workflow_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_execution(id:, **opts) ⇒ RetrieveExecution200Response

Retrieve execution

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :id_type (String) —

    Type of identifier used in the URL

Returns:



97
98
99
100
 
# File 'lib/embed_workflow/api/executions_api.rb', line 97

def retrieve_execution(id:, **opts)
  data, _status_code, _headers = retrieve_execution_with_http_info(id, opts)
  data
end

#retrieve_execution_with_http_info(id, opts = {}) ⇒ Array<(RetrieveExecution200Response, Integer, Hash)>

Retrieve execution

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Options Hash (opts):

  • :id_type (String) —

    Type of identifier used in the URL

Returns:



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
152
153
154
 
# File 'lib/embed_workflow/api/executions_api.rb', line 107

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_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] || 'RetrieveExecution200Response'

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

  new_options = opts.merge(
    :operation => :"ExecutionsApi.retrieve_execution",
    :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: ExecutionsApi#retrieve_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stop_executions(user_key:, **opts) ⇒ Object

Stop executions

Parameters:

  • opts (Hash) —

    the optional parameters

  • user_key (String) —

    User&#39;s key

  • **extra (Hash) —

    Additional properties to include in the request body

Options Hash (**opts):

  • :filters (String) —

    Data to filter

Returns:

  • (Object) 


162
163
164
165
166
167
168
169
170
 
# File 'lib/embed_workflow/api/executions_api.rb', line 162

def stop_executions(user_key:, **opts)
  opts[:'stop_executions_request'] = {
    user_key: user_key,
    filters: opts.delete(:filters),
    **opts.reject { |k, _| k.to_s.start_with?('debug_') }
  }
  data, _status_code, _headers = stop_executions_with_http_info(opts)
  data
end

#stop_executions_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Stop executions

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



176
177
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
 
# File 'lib/embed_workflow/api/executions_api.rb', line 176

def stop_executions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExecutionsApi.stop_executions ...'
  end
  # resource path
  local_var_path = '/api/v1/executions/stop'

  # 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[:'stop_executions_request'])

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

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

  new_options = opts.merge(
    :operation => :"ExecutionsApi.stop_executions",
    :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: ExecutionsApi#stop_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end