Class: RagieRubySdk::ConnectionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/api/connections_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConnectionsApi

Returns a new instance of ConnectionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_connection(public_create_connection, opts = {}) ⇒ Connection

Create Connection Create a connection. This is only for non-oauth connections such as S3 compatible connections, Freshdesk, and Zendesk.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 27

def create_connection(public_create_connection, opts = {})
  data, _status_code, _headers = create_connection_with_http_info(public_create_connection, opts)
  data
end

#create_connection_with_http_info(public_create_connection, opts = {}) ⇒ Array<(Connection, Integer, Hash)>

Create Connection Create a connection. This is only for non-oauth connections such as S3 compatible connections, Freshdesk, and Zendesk.

Parameters:

Returns:

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

    Connection data, response status code and response headers



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
82
83
84
85
86
87
88
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 37

def create_connection_with_http_info(public_create_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.create_connection ...'
  end
  # verify the required parameter 'public_create_connection' is set
  if @api_client.config.client_side_validation && public_create_connection.nil?
    fail ArgumentError, "Missing the required parameter 'public_create_connection' when calling ConnectionsApi.create_connection"
  end
  # resource path
  local_var_path = '/connection'

  # 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']) unless header_params['Accept']
  # 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(public_create_connection)

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

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

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

#create_oauth_redirect_url_connections_oauth_post(o_auth_url_create, opts = {}) ⇒ OAuthUrlResponse

Create Oauth Redirect Url Creates a redirect url to redirect the user to when initializing an embedded connector.

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 95

def create_oauth_redirect_url_connections_oauth_post(o_auth_url_create, opts = {})
  data, _status_code, _headers = create_oauth_redirect_url_connections_oauth_post_with_http_info(o_auth_url_create, opts)
  data
end

#create_oauth_redirect_url_connections_oauth_post_with_http_info(o_auth_url_create, opts = {}) ⇒ Array<(OAuthUrlResponse, Integer, Hash)>

Create Oauth Redirect Url Creates a redirect url to redirect the user to when initializing an embedded connector.

Parameters:

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

    the optional parameters

Returns:

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

    OAuthUrlResponse data, response status code and response headers



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
150
151
152
153
154
155
156
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 105

def create_oauth_redirect_url_connections_oauth_post_with_http_info(o_auth_url_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.create_oauth_redirect_url_connections_oauth_post ...'
  end
  # verify the required parameter 'o_auth_url_create' is set
  if @api_client.config.client_side_validation && o_auth_url_create.nil?
    fail ArgumentError, "Missing the required parameter 'o_auth_url_create' when calling ConnectionsApi.create_oauth_redirect_url_connections_oauth_post"
  end
  # resource path
  local_var_path = '/connections/oauth'

  # 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']) unless header_params['Accept']
  # 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(o_auth_url_create)

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

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

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

#delete_connection_connections_connection_id_delete_post(connection_id, delete_connection_payload, opts = {}) ⇒ Hash<String, String>

Delete Connection Schedules a connection to be deleted. You can choose to keep the files from the connection or delete them all. If you keep the files, they will no longer be associated to the connection. Deleting can take some time, so you will still see files for a bit after this is called.

Parameters:

  • connection_id (String)
  • delete_connection_payload (DeleteConnectionPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, String>) 


164
165
166
167
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 164

def delete_connection_connections_connection_id_delete_post(connection_id, delete_connection_payload, opts = {})
  data, _status_code, _headers = delete_connection_connections_connection_id_delete_post_with_http_info(connection_id, delete_connection_payload, opts)
  data
end

#delete_connection_connections_connection_id_delete_post_with_http_info(connection_id, delete_connection_payload, opts = {}) ⇒ Array<(Hash<String, String>, Integer, Hash)>

Delete Connection Schedules a connection to be deleted. You can choose to keep the files from the connection or delete them all. If you keep the files, they will no longer be associated to the connection. Deleting can take some time, so you will still see files for a bit after this is called.

Parameters:

  • connection_id (String)
  • delete_connection_payload (DeleteConnectionPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Hash<String, String> data, response status code and response headers



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
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/ragie_ruby_sdk/api/connections_api.rb', line 175

def delete_connection_connections_connection_id_delete_post_with_http_info(connection_id, delete_connection_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.delete_connection_connections_connection_id_delete_post ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.delete_connection_connections_connection_id_delete_post"
  end
  # verify the required parameter 'delete_connection_payload' is set
  if @api_client.config.client_side_validation && delete_connection_payload.nil?
    fail ArgumentError, "Missing the required parameter 'delete_connection_payload' when calling ConnectionsApi.delete_connection_connections_connection_id_delete_post"
  end
  # resource path
  local_var_path = '/connections/{connection_id}/delete'.sub('{' + 'connection_id' + '}', CGI.escape(connection_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']) unless header_params['Accept']
  # 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(delete_connection_payload)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, String>'

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

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

#get_connection_connections_connection_id_get(connection_id, opts = {}) ⇒ Connection

Get Connection Get a connection.

Parameters:

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 237

def get_connection_connections_connection_id_get(connection_id, opts = {})
  data, _status_code, _headers = get_connection_connections_connection_id_get_with_http_info(connection_id, opts)
  data
end

#get_connection_connections_connection_id_get_with_http_info(connection_id, opts = {}) ⇒ Array<(Connection, Integer, Hash)>

Get Connection Get a connection.

Parameters:

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

    the optional parameters

Returns:

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

    Connection data, response status code and response headers



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
290
291
292
293
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 247

def get_connection_connections_connection_id_get_with_http_info(connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.get_connection_connections_connection_id_get ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.get_connection_connections_connection_id_get"
  end
  # resource path
  local_var_path = '/connections/{connection_id}'.sub('{' + 'connection_id' + '}', CGI.escape(connection_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']) unless header_params['Accept']

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

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

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

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

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

#get_connection_stats_connections_connection_id_stats_get(connection_id, opts = {}) ⇒ ConnectionStats

Get Connection Stats Lists connection stats: total documents active documents, total active pages.

Parameters:

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

    the optional parameters

Returns:



300
301
302
303
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 300

def get_connection_stats_connections_connection_id_stats_get(connection_id, opts = {})
  data, _status_code, _headers = get_connection_stats_connections_connection_id_stats_get_with_http_info(connection_id, opts)
  data
end

#get_connection_stats_connections_connection_id_stats_get_with_http_info(connection_id, opts = {}) ⇒ Array<(ConnectionStats, Integer, Hash)>

Get Connection Stats Lists connection stats: total documents active documents, total active pages.

Parameters:

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

    the optional parameters

Returns:

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

    ConnectionStats data, response status code and response headers



310
311
312
313
314
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
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 310

def get_connection_stats_connections_connection_id_stats_get_with_http_info(connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.get_connection_stats_connections_connection_id_stats_get ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.get_connection_stats_connections_connection_id_stats_get"
  end
  # resource path
  local_var_path = '/connections/{connection_id}/stats'.sub('{' + 'connection_id' + '}', CGI.escape(connection_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']) unless header_params['Accept']

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

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

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

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

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

#list_connection_source_types_connections_source_type_get(opts = {}) ⇒ ListConnectorSourceTypeInfo

List Connection Source Types List available connection source types like ‘google_drive’ and ‘notion’ along with their metadata

Parameters:

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

    the optional parameters

Returns:



362
363
364
365
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 362

def list_connection_source_types_connections_source_type_get(opts = {})
  data, _status_code, _headers = list_connection_source_types_connections_source_type_get_with_http_info(opts)
  data
end

#list_connection_source_types_connections_source_type_get_with_http_info(opts = {}) ⇒ Array<(ListConnectorSourceTypeInfo, Integer, Hash)>

List Connection Source Types List available connection source types like &#39;google_drive&#39; and &#39;notion&#39; along with their metadata

Parameters:

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

    the optional parameters

Returns:

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

    ListConnectorSourceTypeInfo data, response status code and response headers



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 371

def list_connection_source_types_connections_source_type_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_connection_source_types_connections_source_type_get ...'
  end
  # resource path
  local_var_path = '/connections/source-type'

  # 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']) unless header_params['Accept']

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

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

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

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

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

#list_connections_connections_get(opts = {}) ⇒ ConnectionList

List Connections List all connections sorted by created_at in descending order. Results are paginated with a max limit of 100. When more documents are available, a ‘cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    An opaque cursor for pagination

  • :page_size (Integer) —

    The number of items per page (must be greater than 0 and less than or equal to 100) (default to 10)

  • :filter (String) —

    The metadata search filter. Returns only items which match the filter. The following filter operators are supported: $eq - Equal to (number, string, boolean), $ne - Not equal to (number, string, boolean), $gt - Greater than (number), $gte - Greater than or equal to (number), $lt - Less than (number), $lte - Less than or equal to (number), $in - In array (string or number), $nin - Not in array (string or number). The operators can be combined with AND and OR. Read [Metadata &amp; Filters guide](docs.ragie.ai/docs/metadata-filters) for more details and examples.

  • :partition (String) —

    An optional partition to scope the request to. If omitted, the request will be scoped to the default partition.

Returns:



423
424
425
426
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 423

def list_connections_connections_get(opts = {})
  data, _status_code, _headers = list_connections_connections_get_with_http_info(opts)
  data
end

#list_connections_connections_get_with_http_info(opts = {}) ⇒ Array<(ConnectionList, Integer, Hash)>

List Connections List all connections sorted by created_at in descending order. Results are paginated with a max limit of 100. When more documents are available, a &#x60;cursor&#x60; will be provided. Use the &#x60;cursor&#x60; parameter to retrieve the subsequent page.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    An opaque cursor for pagination

  • :page_size (Integer) —

    The number of items per page (must be greater than 0 and less than or equal to 100) (default to 10)

  • :filter (String) —

    The metadata search filter. Returns only items which match the filter. The following filter operators are supported: $eq - Equal to (number, string, boolean), $ne - Not equal to (number, string, boolean), $gt - Greater than (number), $gte - Greater than or equal to (number), $lt - Less than (number), $lte - Less than or equal to (number), $in - In array (string or number), $nin - Not in array (string or number). The operators can be combined with AND and OR. Read [Metadata &amp; Filters guide](docs.ragie.ai/docs/metadata-filters) for more details and examples.

  • :partition (String) —

    An optional partition to scope the request to. If omitted, the request will be scoped to the default partition.

Returns:

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

    ConnectionList data, response status code and response headers



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 436

def list_connections_connections_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_connections_connections_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ConnectionsApi.list_connections_connections_get, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ConnectionsApi.list_connections_connections_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/connections'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#set_connection_enabled_connections_connection_id_enabled_put(connection_id, set_connection_enabled_payload, opts = {}) ⇒ Connection

Set Connection Enabled Enable or disable the connection. A disabled connection won’t sync.

Parameters:

  • connection_id (String)
  • set_connection_enabled_payload (SetConnectionEnabledPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



498
499
500
501
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 498

def set_connection_enabled_connections_connection_id_enabled_put(connection_id, set_connection_enabled_payload, opts = {})
  data, _status_code, _headers = set_connection_enabled_connections_connection_id_enabled_put_with_http_info(connection_id, set_connection_enabled_payload, opts)
  data
end

#set_connection_enabled_connections_connection_id_enabled_put_with_http_info(connection_id, set_connection_enabled_payload, opts = {}) ⇒ Array<(Connection, Integer, Hash)>

Set Connection Enabled Enable or disable the connection. A disabled connection won&#39;t sync.

Parameters:

  • connection_id (String)
  • set_connection_enabled_payload (SetConnectionEnabledPayload)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Connection data, response status code and response headers



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 509

def set_connection_enabled_connections_connection_id_enabled_put_with_http_info(connection_id, set_connection_enabled_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.set_connection_enabled_connections_connection_id_enabled_put ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.set_connection_enabled_connections_connection_id_enabled_put"
  end
  # verify the required parameter 'set_connection_enabled_payload' is set
  if @api_client.config.client_side_validation && set_connection_enabled_payload.nil?
    fail ArgumentError, "Missing the required parameter 'set_connection_enabled_payload' when calling ConnectionsApi.set_connection_enabled_connections_connection_id_enabled_put"
  end
  # resource path
  local_var_path = '/connections/{connection_id}/enabled'.sub('{' + 'connection_id' + '}', CGI.escape(connection_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']) unless header_params['Accept']
  # 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(set_connection_enabled_payload)

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

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

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

#set_connection_limits_connections_connection_id_limit_put(connection_id, connection_limit_params, opts = {}) ⇒ Connection

Set Connection Limits Sets limits on a connection. Limits can be set on the total number of pages a connection can sync. When the limit is reached, the connection will be disabled. Limit may be removed by setting it to ‘null`.

Parameters:

  • connection_id (String)
  • connection_limit_params (ConnectionLimitParams)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



572
573
574
575
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 572

def set_connection_limits_connections_connection_id_limit_put(connection_id, connection_limit_params, opts = {})
  data, _status_code, _headers = set_connection_limits_connections_connection_id_limit_put_with_http_info(connection_id, connection_limit_params, opts)
  data
end

#set_connection_limits_connections_connection_id_limit_put_with_http_info(connection_id, connection_limit_params, opts = {}) ⇒ Array<(Connection, Integer, Hash)>

Set Connection Limits Sets limits on a connection. Limits can be set on the total number of pages a connection can sync. When the limit is reached, the connection will be disabled. Limit may be removed by setting it to &#x60;null&#x60;.

Parameters:

  • connection_id (String)
  • connection_limit_params (ConnectionLimitParams)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Connection data, response status code and response headers



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 583

def set_connection_limits_connections_connection_id_limit_put_with_http_info(connection_id, connection_limit_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.set_connection_limits_connections_connection_id_limit_put ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.set_connection_limits_connections_connection_id_limit_put"
  end
  # verify the required parameter 'connection_limit_params' is set
  if @api_client.config.client_side_validation && connection_limit_params.nil?
    fail ArgumentError, "Missing the required parameter 'connection_limit_params' when calling ConnectionsApi.set_connection_limits_connections_connection_id_limit_put"
  end
  # resource path
  local_var_path = '/connections/{connection_id}/limit'.sub('{' + 'connection_id' + '}', CGI.escape(connection_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']) unless header_params['Accept']
  # 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(connection_limit_params)

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

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

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

#sync_connection(connection_id, opts = {}) ⇒ ResponseOK

Sync Connection Schedules a connector to sync as soon as possible.

Parameters:

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

    the optional parameters

Returns:



645
646
647
648
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 645

def sync_connection(connection_id, opts = {})
  data, _status_code, _headers = sync_connection_with_http_info(connection_id, opts)
  data
end

#sync_connection_with_http_info(connection_id, opts = {}) ⇒ Array<(ResponseOK, Integer, Hash)>

Sync Connection Schedules a connector to sync as soon as possible.

Parameters:

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

    the optional parameters

Returns:

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

    ResponseOK data, response status code and response headers



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 655

def sync_connection_with_http_info(connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.sync_connection ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.sync_connection"
  end
  # resource path
  local_var_path = '/connections/{connection_id}/sync'.sub('{' + 'connection_id' + '}', CGI.escape(connection_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']) unless header_params['Accept']

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

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

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

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

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

#update_connection_connections_connection_id_put(connection_id, connection_base, opts = {}) ⇒ Connection

Update Connection Updates a connections metadata or mode. These changes will be seen after the next sync.

Parameters:

  • connection_id (String)
  • connection_base (ConnectionBase)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



709
710
711
712
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 709

def update_connection_connections_connection_id_put(connection_id, connection_base, opts = {})
  data, _status_code, _headers = update_connection_connections_connection_id_put_with_http_info(connection_id, connection_base, opts)
  data
end

#update_connection_connections_connection_id_put_with_http_info(connection_id, connection_base, opts = {}) ⇒ Array<(Connection, Integer, Hash)>

Update Connection Updates a connections metadata or mode. These changes will be seen after the next sync.

Parameters:

  • connection_id (String)
  • connection_base (ConnectionBase)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Connection data, response status code and response headers



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/ragie_ruby_sdk/api/connections_api.rb', line 720

def update_connection_connections_connection_id_put_with_http_info(connection_id, connection_base, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConnectionsApi.update_connection_connections_connection_id_put ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ConnectionsApi.update_connection_connections_connection_id_put"
  end
  # verify the required parameter 'connection_base' is set
  if @api_client.config.client_side_validation && connection_base.nil?
    fail ArgumentError, "Missing the required parameter 'connection_base' when calling ConnectionsApi.update_connection_connections_connection_id_put"
  end
  # resource path
  local_var_path = '/connections/{connection_id}'.sub('{' + 'connection_id' + '}', CGI.escape(connection_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']) unless header_params['Accept']
  # 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(connection_base)

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

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

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