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

Get informations about a bank document (RIB)

Parameters:

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

    the optional parameters

Returns:



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

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

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

Get informations about a bank document (RIB)

Parameters:

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

    the optional parameters

Returns:



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

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

  # 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 => '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(body, opts = {}) ⇒ CheckDocumentBankAccountsOutput

Verify a bank document (RIB)

Parameters:

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 78

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

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

Verify a bank document (RIB)

Parameters:

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

    the optional parameters

Returns:



87
88
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
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 87

def check_document_bank_accounts_post_with_http_info(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 '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'])

  # 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(: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, opts = {}) ⇒ CheckDocumentIdentitiesOutput

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

Parameters:

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

    the optional parameters

Returns:



128
129
130
131
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 128

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

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

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

Parameters:

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

    the optional parameters

Returns:



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
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 137

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

  # 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 => '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(body, opts = {}) ⇒ CheckDocumentIdentitiesOutput

Verify an identity document (passport, id cards)

Parameters:

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

    the optional parameters

Returns:



180
181
182
183
 
# File 'lib/yousign_client/api/check_documents_api.rb', line 180

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

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

Verify an identity document (passport, id cards)

Parameters:

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

    the optional parameters

Returns:



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

def check_document_identities_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: 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'])

  # 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(: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