Class: YousignClient::AuthenticationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/yousign_client/api/authentications_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthenticationsApi

Returns a new instance of AuthenticationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#authentications_email_id_get(id, authorization, opts = {}) ⇒ AuthenticationEmailOutput

Find an Authentication by ID

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/yousign_client/api/authentications_api.rb', line 27

def authentications_email_id_get(id, authorization, opts = {})
  data, _status_code, _headers = authentications_email_id_get_with_http_info(id, authorization, opts)
  data
end

#authentications_email_id_get_with_http_info(id, authorization, opts = {}) ⇒ Array<(AuthenticationEmailOutput, Fixnum, Hash)>

Find an Authentication by ID

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:

  • (Array<(AuthenticationEmailOutput, Fixnum, Hash)>) —

    AuthenticationEmailOutput 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
 
# File 'lib/yousign_client/api/authentications_api.rb', line 37

def authentications_email_id_get_with_http_info(id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationsApi.authentications_email_id_get ...'
  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 AuthenticationsApi.authentications_email_id_get"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthenticationsApi.authentications_email_id_get"
  end
  # resource path
  local_var_path = '/authentications/email/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticationEmailOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationsApi#authentications_email_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authentications_email_id_put(id, authorization, content_type, body, opts = {}) ⇒ AuthenticationEmailOutput

Update an Email Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/yousign_client/api/authentications_api.rb', line 88

def authentications_email_id_put(id, authorization, content_type, body, opts = {})
  data, _status_code, _headers = authentications_email_id_put_with_http_info(id, authorization, content_type, body, opts)
  data
end

#authentications_email_id_put_with_http_info(id, authorization, content_type, body, opts = {}) ⇒ Array<(AuthenticationEmailOutput, Fixnum, Hash)>

Update an Email Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:

  • (Array<(AuthenticationEmailOutput, Fixnum, Hash)>) —

    AuthenticationEmailOutput 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
146
147
148
149
150
 
# File 'lib/yousign_client/api/authentications_api.rb', line 100

def authentications_email_id_put_with_http_info(id, authorization, content_type, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationsApi.authentications_email_id_put ...'
  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 AuthenticationsApi.authentications_email_id_put"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthenticationsApi.authentications_email_id_put"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AuthenticationsApi.authentications_email_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AuthenticationsApi.authentications_email_id_put"
  end
  # resource path
  local_var_path = '/authentications/email/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Authorization'] = authorization
  header_params[:'Content-Type'] = content_type

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticationEmailOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationsApi#authentications_email_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authentications_inwebo_id_get(id, authorization, opts = {}) ⇒ AuthenticationInweboOutput

Get an Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/yousign_client/api/authentications_api.rb', line 156

def authentications_inwebo_id_get(id, authorization, opts = {})
  data, _status_code, _headers = authentications_inwebo_id_get_with_http_info(id, authorization, opts)
  data
end

#authentications_inwebo_id_get_with_http_info(id, authorization, opts = {}) ⇒ Array<(AuthenticationInweboOutput, Fixnum, Hash)>

Get an Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:

  • (Array<(AuthenticationInweboOutput, Fixnum, Hash)>) —

    AuthenticationInweboOutput data, response status code and response headers



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
207
208
209
 
# File 'lib/yousign_client/api/authentications_api.rb', line 166

def authentications_inwebo_id_get_with_http_info(id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationsApi.authentications_inwebo_id_get ...'
  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 AuthenticationsApi.authentications_inwebo_id_get"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthenticationsApi.authentications_inwebo_id_get"
  end
  # resource path
  local_var_path = '/authentications/inwebo/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticationInweboOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationsApi#authentications_inwebo_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authentications_inwebo_id_put(id, authorization, content_type, body, opts = {}) ⇒ AuthenticationInweboOutput

Update an inwebo Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:



217
218
219
220
 
# File 'lib/yousign_client/api/authentications_api.rb', line 217

def authentications_inwebo_id_put(id, authorization, content_type, body, opts = {})
  data, _status_code, _headers = authentications_inwebo_id_put_with_http_info(id, authorization, content_type, body, opts)
  data
end

#authentications_inwebo_id_put_with_http_info(id, authorization, content_type, body, opts = {}) ⇒ Array<(AuthenticationInweboOutput, Fixnum, Hash)>

Update an inwebo Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:

  • (Array<(AuthenticationInweboOutput, Fixnum, Hash)>) —

    AuthenticationInweboOutput data, response status code and response headers



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/yousign_client/api/authentications_api.rb', line 229

def authentications_inwebo_id_put_with_http_info(id, authorization, content_type, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationsApi.authentications_inwebo_id_put ...'
  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 AuthenticationsApi.authentications_inwebo_id_put"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthenticationsApi.authentications_inwebo_id_put"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AuthenticationsApi.authentications_inwebo_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AuthenticationsApi.authentications_inwebo_id_put"
  end
  # resource path
  local_var_path = '/authentications/inwebo/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Authorization'] = authorization
  header_params[:'Content-Type'] = content_type

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticationInweboOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationsApi#authentications_inwebo_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authentications_sms_id_get(id, authorization, opts = {}) ⇒ AuthenticationSmsOutput

Find an Authentication by ID

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/yousign_client/api/authentications_api.rb', line 285

def authentications_sms_id_get(id, authorization, opts = {})
  data, _status_code, _headers = authentications_sms_id_get_with_http_info(id, authorization, opts)
  data
end

#authentications_sms_id_get_with_http_info(id, authorization, opts = {}) ⇒ Array<(AuthenticationSmsOutput, Fixnum, Hash)>

Find an Authentication by ID

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:

  • (Array<(AuthenticationSmsOutput, Fixnum, Hash)>) —

    AuthenticationSmsOutput data, response status code and response headers



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
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
 
# File 'lib/yousign_client/api/authentications_api.rb', line 295

def authentications_sms_id_get_with_http_info(id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationsApi.authentications_sms_id_get ...'
  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 AuthenticationsApi.authentications_sms_id_get"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthenticationsApi.authentications_sms_id_get"
  end
  # resource path
  local_var_path = '/authentications/sms/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticationSmsOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationsApi#authentications_sms_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authentications_sms_id_put(id, authorization, content_type, body, opts = {}) ⇒ AuthenticationSmsOutput

Update an SMS Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:



346
347
348
349
 
# File 'lib/yousign_client/api/authentications_api.rb', line 346

def authentications_sms_id_put(id, authorization, content_type, body, opts = {})
  data, _status_code, _headers = authentications_sms_id_put_with_http_info(id, authorization, content_type, body, opts)
  data
end

#authentications_sms_id_put_with_http_info(id, authorization, content_type, body, opts = {}) ⇒ Array<(AuthenticationSmsOutput, Fixnum, Hash)>

Update an SMS Authentication

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:

  • (Array<(AuthenticationSmsOutput, Fixnum, Hash)>) —

    AuthenticationSmsOutput data, response status code and response headers



358
359
360
361
362
363
364
365
366
367
368
369
370
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
 
# File 'lib/yousign_client/api/authentications_api.rb', line 358

def authentications_sms_id_put_with_http_info(id, authorization, content_type, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthenticationsApi.authentications_sms_id_put ...'
  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 AuthenticationsApi.authentications_sms_id_put"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthenticationsApi.authentications_sms_id_put"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling AuthenticationsApi.authentications_sms_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AuthenticationsApi.authentications_sms_id_put"
  end
  # resource path
  local_var_path = '/authentications/sms/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Authorization'] = authorization
  header_params[:'Content-Type'] = content_type

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticationSmsOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AuthenticationsApi#authentications_sms_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end