Class: RagieRubySdk::AuthenticatorsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthenticatorsApi

Returns a new instance of AuthenticatorsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_authenticator(payload, opts = {}) ⇒ BaseGetAuthenticator

Create Authenticator Create White labeled connector credentials

Parameters:

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

    the optional parameters

Returns:



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

def create_authenticator(payload, opts = {})
  data, _status_code, _headers = create_authenticator_with_http_info(payload, opts)
  data
end

#create_authenticator_connection(authenticator_id, create_authenticator_connection, opts = {}) ⇒ Connection

Create Authenticator Connection Create a connector for a given authenticator. This requires credentials dependent on the provider. For google drive it is a refresh token.

Parameters:

  • authenticator_id (String)
  • create_authenticator_connection (CreateAuthenticatorConnection)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/ragie_ruby_sdk/api/authenticators_api.rb', line 96

def create_authenticator_connection(authenticator_id, create_authenticator_connection, opts = {})
  data, _status_code, _headers = create_authenticator_connection_with_http_info(authenticator_id, create_authenticator_connection, opts)
  data
end

#create_authenticator_connection_with_http_info(authenticator_id, create_authenticator_connection, opts = {}) ⇒ Array<(Connection, Integer, Hash)>

Create Authenticator Connection Create a connector for a given authenticator. This requires credentials dependent on the provider. For google drive it is a refresh token.

Parameters:

  • authenticator_id (String)
  • create_authenticator_connection (CreateAuthenticatorConnection)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Connection data, response status code and response headers



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
157
158
159
160
161
162
 
# File 'lib/ragie_ruby_sdk/api/authenticators_api.rb', line 107

def create_authenticator_connection_with_http_info(authenticator_id, create_authenticator_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.create_authenticator_connection ...'
  end
  # verify the required parameter 'authenticator_id' is set
  if @api_client.config.client_side_validation && authenticator_id.nil?
    fail ArgumentError, "Missing the required parameter 'authenticator_id' when calling AuthenticatorsApi.create_authenticator_connection"
  end
  # verify the required parameter 'create_authenticator_connection' is set
  if @api_client.config.client_side_validation && create_authenticator_connection.nil?
    fail ArgumentError, "Missing the required parameter 'create_authenticator_connection' when calling AuthenticatorsApi.create_authenticator_connection"
  end
  # resource path
  local_var_path = '/authenticators/{authenticator_id}/connection'.sub('{' + 'authenticator_id' + '}', CGI.escape(authenticator_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(create_authenticator_connection)

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

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

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

#create_authenticator_with_http_info(payload, opts = {}) ⇒ Array<(BaseGetAuthenticator, Integer, Hash)>

Create Authenticator Create White labeled connector credentials

Parameters:

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

    the optional parameters

Returns:

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

    BaseGetAuthenticator 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/authenticators_api.rb', line 37

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

  # 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(payload)

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

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

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

#delete_authenticator_connection(authenticator_id, opts = {}) ⇒ ResponseOK

Delete Authenticator Delete an authenticator. This requires all connections created by that authenticator to be deleted first.

Parameters:

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

    the optional parameters

Returns:



169
170
171
172
 
# File 'lib/ragie_ruby_sdk/api/authenticators_api.rb', line 169

def delete_authenticator_connection(authenticator_id, opts = {})
  data, _status_code, _headers = delete_authenticator_connection_with_http_info(authenticator_id, opts)
  data
end

#delete_authenticator_connection_with_http_info(authenticator_id, opts = {}) ⇒ Array<(ResponseOK, Integer, Hash)>

Delete Authenticator Delete an authenticator. This requires all connections created by that authenticator to be deleted first.

Parameters:

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

    the optional parameters

Returns:

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

    ResponseOK data, response status code and response headers



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

def delete_authenticator_connection_with_http_info(authenticator_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.delete_authenticator_connection ...'
  end
  # verify the required parameter 'authenticator_id' is set
  if @api_client.config.client_side_validation && authenticator_id.nil?
    fail ArgumentError, "Missing the required parameter 'authenticator_id' when calling AuthenticatorsApi.delete_authenticator_connection"
  end
  # resource path
  local_var_path = '/authenticators/{authenticator_id}'.sub('{' + 'authenticator_id' + '}', CGI.escape(authenticator_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 => :"AuthenticatorsApi.delete_authenticator_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: AuthenticatorsApi#delete_authenticator_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_authenticators(opts = {}) ⇒ AuthenticatorList

List Authenticators List all authenticators sorted by created_at in descending order. Results are paginated with a max limit of 100. When more authenticators 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)

Returns:



233
234
235
236
 
# File 'lib/ragie_ruby_sdk/api/authenticators_api.rb', line 233

def list_authenticators(opts = {})
  data, _status_code, _headers = list_authenticators_with_http_info(opts)
  data
end

#list_authenticators_with_http_info(opts = {}) ⇒ Array<(AuthenticatorList, Integer, Hash)>

List Authenticators List all authenticators sorted by created_at in descending order. Results are paginated with a max limit of 100. When more authenticators 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)

Returns:

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

    AuthenticatorList data, response status code and response headers



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
290
291
292
293
294
295
296
 
# File 'lib/ragie_ruby_sdk/api/authenticators_api.rb', line 244

def list_authenticators_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticatorsApi.list_authenticators ...'
  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 AuthenticatorsApi.list_authenticators, 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 AuthenticatorsApi.list_authenticators, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/authenticators'

  # 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?

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

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

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