Class: YousignClient::CheckDocumentsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CheckDocumentsApi

Returns a new instance of CheckDocumentsApi.



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

def api_client
  @api_client
end

Instance Method Details

#check_document_bank_accounts_id_get(id, authorization, opts = {}) ⇒ CheckDocumentBankAccountsOutput

Get informations about a bank document (RIB)

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/check_documents_api.rb', line 27

def check_document_bank_accounts_id_get(id, authorization, opts = {})
  data, _status_code, _headers = check_document_bank_accounts_id_get_with_http_info(id, authorization, opts)
  data
end

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

Get informations about a bank document (RIB)

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:



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

def check_document_bank_accounts_id_get_with_http_info(id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_bank_accounts_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 CheckDocumentsApi.check_document_bank_accounts_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 CheckDocumentsApi.check_document_bank_accounts_id_get"
  end
  # resource path
  local_var_path = '/check-document/bank_accounts/{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 => 'CheckDocumentBankAccountsOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_bank_accounts_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_document_bank_accounts_post(authorization, content_type, body, opts = {}) ⇒ CheckDocumentBankAccountsOutput

Verify a bank document (RIB)

Parameters:

  • 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:



87
88
89
90
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 87

def check_document_bank_accounts_post(authorization, content_type, body, opts = {})
  data, _status_code, _headers = check_document_bank_accounts_post_with_http_info(authorization, content_type, body, opts)
  data
end

#check_document_bank_accounts_post_with_http_info(authorization, content_type, body, opts = {}) ⇒ Array<(CheckDocumentBankAccountsOutput, Fixnum, Hash)>

Verify a bank document (RIB)

Parameters:

  • 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:



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 98

def check_document_bank_accounts_post_with_http_info(authorization, content_type, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_bank_accounts_post ...'
  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 CheckDocumentsApi.check_document_bank_accounts_post"
  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 CheckDocumentsApi.check_document_bank_accounts_post"
  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 CheckDocumentsApi.check_document_bank_accounts_post"
  end
  # resource path
  local_var_path = '/check-document/bank_accounts'

  # 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(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CheckDocumentBankAccountsOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_bank_accounts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_document_identities_id_get(id, authorization, opts = {}) ⇒ CheckDocumentIdentitiesOutput

Get informations about an identity document (passport, id cards)

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 150

def check_document_identities_id_get(id, authorization, opts = {})
  data, _status_code, _headers = check_document_identities_id_get_with_http_info(id, authorization, opts)
  data
end

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

Get informations about an identity document (passport, id cards)

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:



160
161
162
163
164
165
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
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 160

def check_document_identities_id_get_with_http_info(id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_identities_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 CheckDocumentsApi.check_document_identities_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 CheckDocumentsApi.check_document_identities_id_get"
  end
  # resource path
  local_var_path = '/check-document/identities/{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 => 'CheckDocumentIdentitiesOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_identities_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_document_identities_post(authorization, content_type, body, opts = {}) ⇒ CheckDocumentIdentitiesOutput

Verify an identity document (passport, id cards)

Parameters:

  • 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:



210
211
212
213
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 210

def check_document_identities_post(authorization, content_type, body, opts = {})
  data, _status_code, _headers = check_document_identities_post_with_http_info(authorization, content_type, body, opts)
  data
end

#check_document_identities_post_with_http_info(authorization, content_type, body, opts = {}) ⇒ Array<(CheckDocumentIdentitiesOutput, Fixnum, Hash)>

Verify an identity document (passport, id cards)

Parameters:

  • 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:



221
222
223
224
225
226
227
228
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
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 221

def check_document_identities_post_with_http_info(authorization, content_type, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckDocumentsApi.check_document_identities_post ...'
  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 CheckDocumentsApi.check_document_identities_post"
  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 CheckDocumentsApi.check_document_identities_post"
  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 CheckDocumentsApi.check_document_identities_post"
  end
  # resource path
  local_var_path = '/check-document/identities'

  # 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(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CheckDocumentIdentitiesOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckDocumentsApi#check_document_identities_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end