Class: EmbedWorkflow::TriggersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TriggersApi

Returns a new instance of TriggersApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_trigger(id:, **opts) ⇒ DeleteActionType200Response

Delete trigger

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 26

def delete_trigger(id:, **opts)
  data, _status_code, _headers = delete_trigger_with_http_info(id, opts)
  data
end

#delete_trigger_with_http_info(id, opts = {}) ⇒ Array<(DeleteActionType200Response, Integer, Hash)>

Delete trigger

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Returns:

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

    DeleteActionType200Response data, response status code and response headers



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
73
74
75
76
77
78
79
80
81
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 35

def delete_trigger_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TriggersApi.delete_trigger ...'
  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 TriggersApi.delete_trigger"
  end
  # resource path
  local_var_path = '/api/v1/triggers/{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/json'])

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

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

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

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

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

#list_triggers(**opts) ⇒ ListTriggers200Response

List triggers

Parameters:

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



89
90
91
92
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 89

def list_triggers(**opts)
  data, _status_code, _headers = list_triggers_with_http_info(opts)
  data
end

#list_triggers_with_http_info(opts = {}) ⇒ Array<(ListTriggers200Response, Integer, Hash)>

List triggers

Parameters:

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

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

    ListTriggers200Response data, response status code and response headers



100
101
102
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
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 100

def list_triggers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TriggersApi.list_triggers ...'
  end
  # resource path
  local_var_path = '/api/v1/triggers'

  # 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] || 'ListTriggers200Response'

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

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

#retrieve_trigger(id:, **opts) ⇒ ListTriggers200ResponseCollectionInner

Retrieve trigger

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 151

def retrieve_trigger(id:, **opts)
  data, _status_code, _headers = retrieve_trigger_with_http_info(id, opts)
  data
end

#retrieve_trigger_with_http_info(id, opts = {}) ⇒ Array<(ListTriggers200ResponseCollectionInner, Integer, Hash)>

Retrieve trigger

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Returns:



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
198
199
200
201
202
203
204
205
206
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 160

def retrieve_trigger_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TriggersApi.retrieve_trigger ...'
  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 TriggersApi.retrieve_trigger"
  end
  # resource path
  local_var_path = '/api/v1/triggers/{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/json'])

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

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

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

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

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

#update_trigger(id:, **opts) ⇒ ListTriggers200ResponseCollectionInner

Update trigger

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :event (String) —

    The trigger&#39;s key

  • :title (String) —

    Title

Returns:



214
215
216
217
218
219
220
221
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 214

def update_trigger(id:, **opts)
  opts[:'update_trigger_request'] = UpdateTriggerRequest.new(
    event: opts.delete(:event),
    title: opts.delete(:title),
  )
  data, _status_code, _headers = update_trigger_with_http_info(id, opts)
  data
end

#update_trigger_with_http_info(id, opts = {}) ⇒ Array<(ListTriggers200ResponseCollectionInner, Integer, Hash)>

Update trigger

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Options Hash (opts):

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
 
# File 'lib/embed_workflow/api/triggers_api.rb', line 228

def update_trigger_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TriggersApi.update_trigger ...'
  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 TriggersApi.update_trigger"
  end
  # resource path
  local_var_path = '/api/v1/triggers/{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/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[:'update_trigger_request'])

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

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

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