Class: EmbedWorkflow::AppConnectionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AppConnectionsApi

Returns a new instance of AppConnectionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_app_connection(name:, app_type:, user_key:, config:, **opts) ⇒ ListAppConnections200ResponseCollectionInner

Create app connection

Parameters:

  • opts (Hash) —

    the optional parameters

  • name (String) —

    Name of resource

  • app_type (String) —

    App Type

  • user_key (String) —

    User's key

  • config (Object) —

    App connection configuration

Returns:



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 29

def create_app_connection(name:, app_type:, user_key:, config:, **opts)
  opts[:'create_app_connection_request'] = CreateAppConnectionRequest.new(
    name: name,
    app_type: app_type,
    user_key: user_key,
    config: config,
  )
  data, _status_code, _headers = create_app_connection_with_http_info(opts)
  data
end

#create_app_connection_with_http_info(opts = {}) ⇒ Array<(ListAppConnections200ResponseCollectionInner, Integer, Hash)>

Create app connection

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
91
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 44

def create_app_connection_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppConnectionsApi.create_app_connection ...'
  end
  # resource path
  local_var_path = '/api/v1/app_connections'

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

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

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

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

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

Delete app connection

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :user_key (String) —

    Unique user identifier

Returns:



98
99
100
101
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 98

def delete_app_connection(id:, **opts)
  data, _status_code, _headers = delete_app_connection_with_http_info(id, opts)
  data
end

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

Delete app connection

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Options Hash (opts):

  • :user_key (String) —

    Unique user identifier

Returns:

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

    DeleteActionType200Response data, response status code and response headers



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
155
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 108

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_key'] = opts[:'user_key'] if !opts[:'user_key'].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] || 'DeleteActionType200Response'

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

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

#list_app_connections(**opts) ⇒ ListAppConnections200Response

List app connections

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)

  • :user_key (String) —

    Unique user identifier

  • :app_type (String) —

    Filter results by app type

Returns:



165
166
167
168
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 165

def list_app_connections(**opts)
  data, _status_code, _headers = list_app_connections_with_http_info(opts)
  data
end

#list_app_connections_with_http_info(opts = {}) ⇒ Array<(ListAppConnections200Response, Integer, Hash)>

List app connections

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)

  • :user_key (String) —

    Unique user identifier

  • :app_type (String) —

    Filter results by app type

Returns:



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
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 178

def list_app_connections_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppConnectionsApi.list_app_connections ...'
  end
  # resource path
  local_var_path = '/api/v1/app_connections'

  # 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?
  query_params[:'user_key'] = opts[:'user_key'] if !opts[:'user_key'].nil?
  query_params[:'app_type'] = opts[:'app_type'] if !opts[:'app_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] || 'ListAppConnections200Response'

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

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

#retrieve_app_connection(id:, **opts) ⇒ ListAppConnections200ResponseCollectionInner

Retrieve app connection

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :user_key (String) —

    Unique user identifier

Returns:



232
233
234
235
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 232

def retrieve_app_connection(id:, **opts)
  data, _status_code, _headers = retrieve_app_connection_with_http_info(id, opts)
  data
end

#retrieve_app_connection_with_http_info(id, opts = {}) ⇒ Array<(ListAppConnections200ResponseCollectionInner, Integer, Hash)>

Retrieve app connection

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Options Hash (opts):

  • :user_key (String) —

    Unique user identifier

Returns:



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
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 242

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_key'] = opts[:'user_key'] if !opts[:'user_key'].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] || 'ListAppConnections200ResponseCollectionInner'

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

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

#update_app_connection(id:, name:, app_type:, user_key:, config:, **opts) ⇒ ListAppConnections200ResponseCollectionInner

Update app connection

Parameters:

  • id (String) —

    System-generated unique identifier

  • opts (Hash) —

    the optional parameters

  • name (String) —

    Name of resource

  • app_type (String) —

    App Type

  • user_key (String) —

    User&#39;s key

  • config (Object) —

    App connection configuration

Returns:



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 299

def update_app_connection(id:, name:, app_type:, user_key:, config:, **opts)
  opts[:'create_app_connection_request'] = CreateAppConnectionRequest.new(
    name: name,
    app_type: app_type,
    user_key: user_key,
    config: config,
  )
  data, _status_code, _headers = update_app_connection_with_http_info(id, opts)
  data
end

#update_app_connection_with_http_info(id, opts = {}) ⇒ Array<(ListAppConnections200ResponseCollectionInner, Integer, Hash)>

Update app connection

Parameters:

  • id (String) —

    System-generated unique identifier

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

    the optional parameters

Options Hash (opts):

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/embed_workflow/api/app_connections_api.rb', line 315

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

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

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

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