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, opts = {}) ⇒ AuthenticationEmailOutput

Find an Authentication by ID

Parameters:

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

    the optional parameters

Returns:



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

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

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

Find an Authentication by ID

Parameters:

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

    the optional parameters

Returns:

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

    AuthenticationEmailOutput data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/yousign_client/api/authentications_api.rb', line 35

def authentications_email_id_get_with_http_info(id, 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
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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, body, opts = {}) ⇒ AuthenticationEmailOutput

Update an Email Authentication

Parameters:

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/yousign_client/api/authentications_api.rb', line 79

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

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

Update an Email Authentication

Parameters:

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

    the optional parameters

Returns:

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

    AuthenticationEmailOutput data, response status code and response headers



89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'lib/yousign_client/api/authentications_api.rb', line 89

def authentications_email_id_put_with_http_info(id, 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 '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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  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, opts = {}) ⇒ AuthenticationInweboOutput

Get an Authentication

Parameters:

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

    the optional parameters

Returns:



134
135
136
137
 
# File 'lib/yousign_client/api/authentications_api.rb', line 134

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

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

Get an Authentication

Parameters:

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

    the optional parameters

Returns:

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

    AuthenticationInweboOutput data, response status code and response headers



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/yousign_client/api/authentications_api.rb', line 143

def authentications_inwebo_id_get_with_http_info(id, 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
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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, body, opts = {}) ⇒ AuthenticationInweboOutput

Update an inwebo Authentication

Parameters:

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

    the optional parameters

Returns:



187
188
189
190
 
# File 'lib/yousign_client/api/authentications_api.rb', line 187

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

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

Update an inwebo Authentication

Parameters:

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

    the optional parameters

Returns:

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

    AuthenticationInweboOutput data, response status code and response headers



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
231
232
233
234
235
236
237
 
# File 'lib/yousign_client/api/authentications_api.rb', line 197

def authentications_inwebo_id_put_with_http_info(id, 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 '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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  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, opts = {}) ⇒ AuthenticationSmsOutput

Find an Authentication by ID

Parameters:

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

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/yousign_client/api/authentications_api.rb', line 242

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

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

Find an Authentication by ID

Parameters:

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

    the optional parameters

Returns:

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

    AuthenticationSmsOutput data, response status code and response headers



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

def authentications_sms_id_get_with_http_info(id, 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
  # 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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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, body, opts = {}) ⇒ AuthenticationSmsOutput

Update an SMS Authentication

Parameters:

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

    the optional parameters

Returns:



295
296
297
298
 
# File 'lib/yousign_client/api/authentications_api.rb', line 295

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

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

Update an SMS Authentication

Parameters:

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

    the optional parameters

Returns:

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

    AuthenticationSmsOutput data, response status code and response headers



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
339
340
341
342
343
344
345
 
# File 'lib/yousign_client/api/authentications_api.rb', line 305

def authentications_sms_id_put_with_http_info(id, 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 '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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  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