yousign_client 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -8
- data/config.json +2 -2
- data/docs/AuthenticationsApi.md +60 -45
- data/docs/CheckDocumentsApi.md +40 -30
- data/docs/ConsentProcessesApi.md +80 -57
- data/docs/FileObjectsApi.md +40 -30
- data/docs/FilesApi.md +40 -30
- data/docs/InlineObject.md +17 -0
- data/docs/InlineObject1.md +19 -0
- data/docs/InlineObject2.md +19 -0
- data/docs/MembersApi.md +50 -36
- data/docs/OperationsApi.md +20 -15
- data/docs/OrganizationsApi.md +11 -10
- data/docs/ProceduresApi.md +90 -66
- data/docs/ServerStampsApi.md +20 -15
- data/docs/SignatureUIsApi.md +101 -82
- data/docs/UserGroupsApi.md +21 -16
- data/docs/UsersApi.md +51 -40
- data/docs/WorkspacesApi.md +11 -10
- data/lib/yousign_client/api/authentications_api.rb +24 -87
- data/lib/yousign_client/api/check_documents_api.rb +16 -58
- data/lib/yousign_client/api/consent_processes_api.rb +32 -109
- data/lib/yousign_client/api/file_objects_api.rb +16 -58
- data/lib/yousign_client/api/files_api.rb +16 -58
- data/lib/yousign_client/api/members_api.rb +20 -69
- data/lib/yousign_client/api/operations_api.rb +8 -29
- data/lib/yousign_client/api/organizations_api.rb +4 -11
- data/lib/yousign_client/api/procedures_api.rb +36 -127
- data/lib/yousign_client/api/server_stamps_api.rb +8 -29
- data/lib/yousign_client/api/signature_u_is_api.rb +40 -152
- data/lib/yousign_client/api/user_groups_api.rb +8 -22
- data/lib/yousign_client/api/users_api.rb +20 -69
- data/lib/yousign_client/api/workspaces_api.rb +4 -11
- data/lib/yousign_client/configuration.rb +1 -1
- data/lib/yousign_client/models/check_document_bank_accounts_output.rb +0 -15
- data/lib/yousign_client/models/check_document_identities_output.rb +0 -15
- data/lib/yousign_client/models/file_object_input.rb +0 -15
- data/lib/yousign_client/models/file_object_input_without_file_reference.rb +0 -15
- data/lib/yousign_client/models/file_object_output.rb +0 -30
- data/lib/yousign_client/models/file_object_output_without_file_reference.rb +0 -30
- data/lib/yousign_client/models/file_output.rb +0 -30
- data/lib/yousign_client/models/inwebo_user_request.rb +0 -15
- data/lib/yousign_client/models/member_input.rb +2 -2
- data/lib/yousign_client/models/member_output.rb +2 -17
- data/lib/yousign_client/models/organization_output.rb +0 -15
- data/lib/yousign_client/models/procedure_output.rb +0 -45
- data/lib/yousign_client/models/user_group.rb +0 -15
- data/lib/yousign_client/models/user_output.rb +0 -15
- data/lib/yousign_client/models/user_workspace_output.rb +0 -15
- data/lib/yousign_client/models/workspace_output.rb +0 -15
- data/lib/yousign_client/version.rb +1 -1
- data/spec/api/authentications_api_spec.rb +0 -9
- data/spec/api/check_documents_api_spec.rb +0 -6
- data/spec/api/consent_processes_api_spec.rb +0 -11
- data/spec/api/file_objects_api_spec.rb +0 -6
- data/spec/api/files_api_spec.rb +0 -6
- data/spec/api/members_api_spec.rb +0 -7
- data/spec/api/operations_api_spec.rb +0 -3
- data/spec/api/organizations_api_spec.rb +0 -1
- data/spec/api/procedures_api_spec.rb +0 -13
- data/spec/api/server_stamps_api_spec.rb +0 -3
- data/spec/api/signature_u_is_api_spec.rb +0 -16
- data/spec/api/user_groups_api_spec.rb +0 -2
- data/spec/api/users_api_spec.rb +0 -7
- data/spec/api/workspaces_api_spec.rb +0 -1
- data/spec/models/member_input_spec.rb +1 -1
- data/spec/models/member_output_spec.rb +1 -1
- data/update_client.sh +0 -4
- data/yousign_client.gemspec +1 -1
- data/yousign_openapi.json +53 -704
- metadata +7 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f7eb161ceaa2a054d68e72b56821a177ca90e8d1e5b3f87d99b8bdf6b6386837
|
4
|
+
data.tar.gz: 0c56dfa1c0bd8f81b4b39ccd926bf8df2d2747482847eff4429f3d1984c94b75
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 602d911addb002795bf3808e35c1e5b20d3bc2dd9ab647998877e8517dec92dd65c59b02d0faff989a515255338487aef124589ffd9ecdc620d966442b44fd84
|
7
|
+
data.tar.gz: 6ab147e53c7668d200e1481ab1a21c449681ea49fc4597176b8dcf010aad69c7e8bf793e628dc4eb7123a2b10883e7972548ac36e6a6d023c8a298ccc8b8a121
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ For your information, the Yousign API documentation is available at https://dev.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.1
|
10
|
-
- Package version: 1.0.
|
10
|
+
- Package version: 1.0.1
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build yousign_client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./yousign_client-1.0.
|
26
|
+
gem install ./yousign_client-1.0.1.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./yousign_client-1.0.
|
28
|
+
(for development, run `gem install --dev ./yousign_client-1.0.1.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'yousign_client', '~> 1.0.
|
34
|
+
gem 'yousign_client', '~> 1.0.1'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -54,16 +54,22 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
54
54
|
# Load the gem
|
55
55
|
require 'yousign_client'
|
56
56
|
|
57
|
+
# Setup authorization
|
58
|
+
YousignClient.configure do |config|
|
59
|
+
# Configure API key authorization: api_key
|
60
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
61
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
62
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
63
|
+
end
|
64
|
+
|
57
65
|
api_instance = YousignClient::AuthenticationsApi.new
|
58
66
|
|
59
67
|
id = 'id_example' # String |
|
60
68
|
|
61
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
62
|
-
|
63
69
|
|
64
70
|
begin
|
65
71
|
#Find an Authentication by ID
|
66
|
-
result = api_instance.authentications_email_id_get(id,
|
72
|
+
result = api_instance.authentications_email_id_get(id, )
|
67
73
|
p result
|
68
74
|
rescue YousignClient::ApiError => e
|
69
75
|
puts "Exception when calling AuthenticationsApi->authentications_email_id_get: #{e}"
|
@@ -222,7 +228,7 @@ Class | Method | HTTP request | Description
|
|
222
228
|
## Documentation for Authorization
|
223
229
|
|
224
230
|
|
225
|
-
###
|
231
|
+
### api_key
|
226
232
|
|
227
233
|
- **Type**: API key
|
228
234
|
- **API key parameter name**: Authorization
|
data/config.json
CHANGED
@@ -6,6 +6,6 @@
|
|
6
6
|
"gemDescription": "Yousign API Documentation Ruby Gem",
|
7
7
|
"gemHomepage": "https://github.com/cashbee-team/yousign_client",
|
8
8
|
"moduleName": "YousignClient",
|
9
|
-
"gemLicense": "Apache
|
10
|
-
"gemVersion": "1.0.
|
9
|
+
"gemLicense": "Apache-2.0",
|
10
|
+
"gemVersion": "1.0.1"
|
11
11
|
}
|
data/docs/AuthenticationsApi.md
CHANGED
@@ -13,7 +13,7 @@ Method | HTTP request | Description
|
|
13
13
|
|
14
14
|
|
15
15
|
# **authentications_email_id_get**
|
16
|
-
> AuthenticationEmailOutput authentications_email_id_get(id,
|
16
|
+
> AuthenticationEmailOutput authentications_email_id_get(id, )
|
17
17
|
|
18
18
|
Find an Authentication by ID
|
19
19
|
|
@@ -21,17 +21,22 @@ Find an Authentication by ID
|
|
21
21
|
```ruby
|
22
22
|
# load the gem
|
23
23
|
require 'yousign_client'
|
24
|
+
# setup authorization
|
25
|
+
YousignClient.configure do |config|
|
26
|
+
# Configure API key authorization: api_key
|
27
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
30
|
+
end
|
24
31
|
|
25
32
|
api_instance = YousignClient::AuthenticationsApi.new
|
26
33
|
|
27
34
|
id = 'id_example' # String |
|
28
35
|
|
29
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
30
|
-
|
31
36
|
|
32
37
|
begin
|
33
38
|
#Find an Authentication by ID
|
34
|
-
result = api_instance.authentications_email_id_get(id,
|
39
|
+
result = api_instance.authentications_email_id_get(id, )
|
35
40
|
p result
|
36
41
|
rescue YousignClient::ApiError => e
|
37
42
|
puts "Exception when calling AuthenticationsApi->authentications_email_id_get: #{e}"
|
@@ -43,7 +48,6 @@ end
|
|
43
48
|
Name | Type | Description | Notes
|
44
49
|
------------- | ------------- | ------------- | -------------
|
45
50
|
**id** | **String**| |
|
46
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
47
51
|
|
48
52
|
### Return type
|
49
53
|
|
@@ -51,7 +55,7 @@ Name | Type | Description | Notes
|
|
51
55
|
|
52
56
|
### Authorization
|
53
57
|
|
54
|
-
|
58
|
+
[api_key](../README.md#api_key)
|
55
59
|
|
56
60
|
### HTTP request headers
|
57
61
|
|
@@ -61,7 +65,7 @@ No authorization required
|
|
61
65
|
|
62
66
|
|
63
67
|
# **authentications_email_id_put**
|
64
|
-
> AuthenticationEmailOutput authentications_email_id_put(id,
|
68
|
+
> AuthenticationEmailOutput authentications_email_id_put(id, body)
|
65
69
|
|
66
70
|
Update an Email Authentication
|
67
71
|
|
@@ -69,21 +73,24 @@ Update an Email Authentication
|
|
69
73
|
```ruby
|
70
74
|
# load the gem
|
71
75
|
require 'yousign_client'
|
76
|
+
# setup authorization
|
77
|
+
YousignClient.configure do |config|
|
78
|
+
# Configure API key authorization: api_key
|
79
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
80
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
81
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
82
|
+
end
|
72
83
|
|
73
84
|
api_instance = YousignClient::AuthenticationsApi.new
|
74
85
|
|
75
86
|
id = 'id_example' # String |
|
76
87
|
|
77
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
78
|
-
|
79
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
80
|
-
|
81
88
|
body = YousignClient::Body2.new # Body2 |
|
82
89
|
|
83
90
|
|
84
91
|
begin
|
85
92
|
#Update an Email Authentication
|
86
|
-
result = api_instance.authentications_email_id_put(id,
|
93
|
+
result = api_instance.authentications_email_id_put(id, body)
|
87
94
|
p result
|
88
95
|
rescue YousignClient::ApiError => e
|
89
96
|
puts "Exception when calling AuthenticationsApi->authentications_email_id_put: #{e}"
|
@@ -95,8 +102,6 @@ end
|
|
95
102
|
Name | Type | Description | Notes
|
96
103
|
------------- | ------------- | ------------- | -------------
|
97
104
|
**id** | **String**| |
|
98
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
99
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
100
105
|
**body** | [**Body2**](Body2.md)| |
|
101
106
|
|
102
107
|
### Return type
|
@@ -105,7 +110,7 @@ Name | Type | Description | Notes
|
|
105
110
|
|
106
111
|
### Authorization
|
107
112
|
|
108
|
-
|
113
|
+
[api_key](../README.md#api_key)
|
109
114
|
|
110
115
|
### HTTP request headers
|
111
116
|
|
@@ -115,7 +120,7 @@ No authorization required
|
|
115
120
|
|
116
121
|
|
117
122
|
# **authentications_inwebo_id_get**
|
118
|
-
> AuthenticationInweboOutput authentications_inwebo_id_get(id,
|
123
|
+
> AuthenticationInweboOutput authentications_inwebo_id_get(id, )
|
119
124
|
|
120
125
|
Get an Authentication
|
121
126
|
|
@@ -123,17 +128,22 @@ Get an Authentication
|
|
123
128
|
```ruby
|
124
129
|
# load the gem
|
125
130
|
require 'yousign_client'
|
131
|
+
# setup authorization
|
132
|
+
YousignClient.configure do |config|
|
133
|
+
# Configure API key authorization: api_key
|
134
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
135
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
136
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
137
|
+
end
|
126
138
|
|
127
139
|
api_instance = YousignClient::AuthenticationsApi.new
|
128
140
|
|
129
141
|
id = 'id_example' # String |
|
130
142
|
|
131
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
132
|
-
|
133
143
|
|
134
144
|
begin
|
135
145
|
#Get an Authentication
|
136
|
-
result = api_instance.authentications_inwebo_id_get(id,
|
146
|
+
result = api_instance.authentications_inwebo_id_get(id, )
|
137
147
|
p result
|
138
148
|
rescue YousignClient::ApiError => e
|
139
149
|
puts "Exception when calling AuthenticationsApi->authentications_inwebo_id_get: #{e}"
|
@@ -145,7 +155,6 @@ end
|
|
145
155
|
Name | Type | Description | Notes
|
146
156
|
------------- | ------------- | ------------- | -------------
|
147
157
|
**id** | **String**| |
|
148
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
149
158
|
|
150
159
|
### Return type
|
151
160
|
|
@@ -153,7 +162,7 @@ Name | Type | Description | Notes
|
|
153
162
|
|
154
163
|
### Authorization
|
155
164
|
|
156
|
-
|
165
|
+
[api_key](../README.md#api_key)
|
157
166
|
|
158
167
|
### HTTP request headers
|
159
168
|
|
@@ -163,7 +172,7 @@ No authorization required
|
|
163
172
|
|
164
173
|
|
165
174
|
# **authentications_inwebo_id_put**
|
166
|
-
> AuthenticationInweboOutput authentications_inwebo_id_put(id,
|
175
|
+
> AuthenticationInweboOutput authentications_inwebo_id_put(id, body)
|
167
176
|
|
168
177
|
Update an inwebo Authentication
|
169
178
|
|
@@ -171,21 +180,24 @@ Update an inwebo Authentication
|
|
171
180
|
```ruby
|
172
181
|
# load the gem
|
173
182
|
require 'yousign_client'
|
183
|
+
# setup authorization
|
184
|
+
YousignClient.configure do |config|
|
185
|
+
# Configure API key authorization: api_key
|
186
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
187
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
188
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
189
|
+
end
|
174
190
|
|
175
191
|
api_instance = YousignClient::AuthenticationsApi.new
|
176
192
|
|
177
193
|
id = 'id_example' # String |
|
178
194
|
|
179
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
180
|
-
|
181
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
182
|
-
|
183
195
|
body = YousignClient::Body.new # Body |
|
184
196
|
|
185
197
|
|
186
198
|
begin
|
187
199
|
#Update an inwebo Authentication
|
188
|
-
result = api_instance.authentications_inwebo_id_put(id,
|
200
|
+
result = api_instance.authentications_inwebo_id_put(id, body)
|
189
201
|
p result
|
190
202
|
rescue YousignClient::ApiError => e
|
191
203
|
puts "Exception when calling AuthenticationsApi->authentications_inwebo_id_put: #{e}"
|
@@ -197,8 +209,6 @@ end
|
|
197
209
|
Name | Type | Description | Notes
|
198
210
|
------------- | ------------- | ------------- | -------------
|
199
211
|
**id** | **String**| |
|
200
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
201
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
202
212
|
**body** | [**Body**](Body.md)| |
|
203
213
|
|
204
214
|
### Return type
|
@@ -207,7 +217,7 @@ Name | Type | Description | Notes
|
|
207
217
|
|
208
218
|
### Authorization
|
209
219
|
|
210
|
-
|
220
|
+
[api_key](../README.md#api_key)
|
211
221
|
|
212
222
|
### HTTP request headers
|
213
223
|
|
@@ -217,7 +227,7 @@ No authorization required
|
|
217
227
|
|
218
228
|
|
219
229
|
# **authentications_sms_id_get**
|
220
|
-
> AuthenticationSmsOutput authentications_sms_id_get(id,
|
230
|
+
> AuthenticationSmsOutput authentications_sms_id_get(id, )
|
221
231
|
|
222
232
|
Find an Authentication by ID
|
223
233
|
|
@@ -225,17 +235,22 @@ Find an Authentication by ID
|
|
225
235
|
```ruby
|
226
236
|
# load the gem
|
227
237
|
require 'yousign_client'
|
238
|
+
# setup authorization
|
239
|
+
YousignClient.configure do |config|
|
240
|
+
# Configure API key authorization: api_key
|
241
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
242
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
243
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
244
|
+
end
|
228
245
|
|
229
246
|
api_instance = YousignClient::AuthenticationsApi.new
|
230
247
|
|
231
248
|
id = 'id_example' # String |
|
232
249
|
|
233
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
234
|
-
|
235
250
|
|
236
251
|
begin
|
237
252
|
#Find an Authentication by ID
|
238
|
-
result = api_instance.authentications_sms_id_get(id,
|
253
|
+
result = api_instance.authentications_sms_id_get(id, )
|
239
254
|
p result
|
240
255
|
rescue YousignClient::ApiError => e
|
241
256
|
puts "Exception when calling AuthenticationsApi->authentications_sms_id_get: #{e}"
|
@@ -247,7 +262,6 @@ end
|
|
247
262
|
Name | Type | Description | Notes
|
248
263
|
------------- | ------------- | ------------- | -------------
|
249
264
|
**id** | **String**| |
|
250
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
251
265
|
|
252
266
|
### Return type
|
253
267
|
|
@@ -255,7 +269,7 @@ Name | Type | Description | Notes
|
|
255
269
|
|
256
270
|
### Authorization
|
257
271
|
|
258
|
-
|
272
|
+
[api_key](../README.md#api_key)
|
259
273
|
|
260
274
|
### HTTP request headers
|
261
275
|
|
@@ -265,7 +279,7 @@ No authorization required
|
|
265
279
|
|
266
280
|
|
267
281
|
# **authentications_sms_id_put**
|
268
|
-
> AuthenticationSmsOutput authentications_sms_id_put(id,
|
282
|
+
> AuthenticationSmsOutput authentications_sms_id_put(id, body)
|
269
283
|
|
270
284
|
Update an SMS Authentication
|
271
285
|
|
@@ -273,21 +287,24 @@ Update an SMS Authentication
|
|
273
287
|
```ruby
|
274
288
|
# load the gem
|
275
289
|
require 'yousign_client'
|
290
|
+
# setup authorization
|
291
|
+
YousignClient.configure do |config|
|
292
|
+
# Configure API key authorization: api_key
|
293
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
294
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
295
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
296
|
+
end
|
276
297
|
|
277
298
|
api_instance = YousignClient::AuthenticationsApi.new
|
278
299
|
|
279
300
|
id = 'id_example' # String |
|
280
301
|
|
281
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
282
|
-
|
283
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
284
|
-
|
285
302
|
body = YousignClient::Body1.new # Body1 |
|
286
303
|
|
287
304
|
|
288
305
|
begin
|
289
306
|
#Update an SMS Authentication
|
290
|
-
result = api_instance.authentications_sms_id_put(id,
|
307
|
+
result = api_instance.authentications_sms_id_put(id, body)
|
291
308
|
p result
|
292
309
|
rescue YousignClient::ApiError => e
|
293
310
|
puts "Exception when calling AuthenticationsApi->authentications_sms_id_put: #{e}"
|
@@ -299,8 +316,6 @@ end
|
|
299
316
|
Name | Type | Description | Notes
|
300
317
|
------------- | ------------- | ------------- | -------------
|
301
318
|
**id** | **String**| |
|
302
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
303
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
304
319
|
**body** | [**Body1**](Body1.md)| |
|
305
320
|
|
306
321
|
### Return type
|
@@ -309,7 +324,7 @@ Name | Type | Description | Notes
|
|
309
324
|
|
310
325
|
### Authorization
|
311
326
|
|
312
|
-
|
327
|
+
[api_key](../README.md#api_key)
|
313
328
|
|
314
329
|
### HTTP request headers
|
315
330
|
|
data/docs/CheckDocumentsApi.md
CHANGED
@@ -11,7 +11,7 @@ Method | HTTP request | Description
|
|
11
11
|
|
12
12
|
|
13
13
|
# **check_document_bank_accounts_id_get**
|
14
|
-
> CheckDocumentBankAccountsOutput check_document_bank_accounts_id_get(id
|
14
|
+
> CheckDocumentBankAccountsOutput check_document_bank_accounts_id_get(id)
|
15
15
|
|
16
16
|
Get informations about a bank document (RIB)
|
17
17
|
|
@@ -19,17 +19,22 @@ Get informations about a bank document (RIB)
|
|
19
19
|
```ruby
|
20
20
|
# load the gem
|
21
21
|
require 'yousign_client'
|
22
|
+
# setup authorization
|
23
|
+
YousignClient.configure do |config|
|
24
|
+
# Configure API key authorization: api_key
|
25
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
28
|
+
end
|
22
29
|
|
23
30
|
api_instance = YousignClient::CheckDocumentsApi.new
|
24
31
|
|
25
32
|
id = 'id_example' # String |
|
26
33
|
|
27
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
28
|
-
|
29
34
|
|
30
35
|
begin
|
31
36
|
#Get informations about a bank document (RIB)
|
32
|
-
result = api_instance.check_document_bank_accounts_id_get(id
|
37
|
+
result = api_instance.check_document_bank_accounts_id_get(id)
|
33
38
|
p result
|
34
39
|
rescue YousignClient::ApiError => e
|
35
40
|
puts "Exception when calling CheckDocumentsApi->check_document_bank_accounts_id_get: #{e}"
|
@@ -41,7 +46,6 @@ end
|
|
41
46
|
Name | Type | Description | Notes
|
42
47
|
------------- | ------------- | ------------- | -------------
|
43
48
|
**id** | **String**| |
|
44
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
45
49
|
|
46
50
|
### Return type
|
47
51
|
|
@@ -49,7 +53,7 @@ Name | Type | Description | Notes
|
|
49
53
|
|
50
54
|
### Authorization
|
51
55
|
|
52
|
-
|
56
|
+
[api_key](../README.md#api_key)
|
53
57
|
|
54
58
|
### HTTP request headers
|
55
59
|
|
@@ -59,7 +63,7 @@ No authorization required
|
|
59
63
|
|
60
64
|
|
61
65
|
# **check_document_bank_accounts_post**
|
62
|
-
> CheckDocumentBankAccountsOutput check_document_bank_accounts_post(
|
66
|
+
> CheckDocumentBankAccountsOutput check_document_bank_accounts_post(body)
|
63
67
|
|
64
68
|
Verify a bank document (RIB)
|
65
69
|
|
@@ -67,19 +71,22 @@ Verify a bank document (RIB)
|
|
67
71
|
```ruby
|
68
72
|
# load the gem
|
69
73
|
require 'yousign_client'
|
74
|
+
# setup authorization
|
75
|
+
YousignClient.configure do |config|
|
76
|
+
# Configure API key authorization: api_key
|
77
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
78
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
79
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
80
|
+
end
|
70
81
|
|
71
82
|
api_instance = YousignClient::CheckDocumentsApi.new
|
72
83
|
|
73
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
74
|
-
|
75
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
76
|
-
|
77
84
|
body = YousignClient::CheckDocumentBankAccountsInput.new # CheckDocumentBankAccountsInput |
|
78
85
|
|
79
86
|
|
80
87
|
begin
|
81
88
|
#Verify a bank document (RIB)
|
82
|
-
result = api_instance.check_document_bank_accounts_post(
|
89
|
+
result = api_instance.check_document_bank_accounts_post(body)
|
83
90
|
p result
|
84
91
|
rescue YousignClient::ApiError => e
|
85
92
|
puts "Exception when calling CheckDocumentsApi->check_document_bank_accounts_post: #{e}"
|
@@ -90,8 +97,6 @@ end
|
|
90
97
|
|
91
98
|
Name | Type | Description | Notes
|
92
99
|
------------- | ------------- | ------------- | -------------
|
93
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
94
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
95
100
|
**body** | [**CheckDocumentBankAccountsInput**](CheckDocumentBankAccountsInput.md)| |
|
96
101
|
|
97
102
|
### Return type
|
@@ -100,7 +105,7 @@ Name | Type | Description | Notes
|
|
100
105
|
|
101
106
|
### Authorization
|
102
107
|
|
103
|
-
|
108
|
+
[api_key](../README.md#api_key)
|
104
109
|
|
105
110
|
### HTTP request headers
|
106
111
|
|
@@ -110,7 +115,7 @@ No authorization required
|
|
110
115
|
|
111
116
|
|
112
117
|
# **check_document_identities_id_get**
|
113
|
-
> CheckDocumentIdentitiesOutput check_document_identities_id_get(id
|
118
|
+
> CheckDocumentIdentitiesOutput check_document_identities_id_get(id)
|
114
119
|
|
115
120
|
Get informations about an identity document (passport, id cards)
|
116
121
|
|
@@ -118,17 +123,22 @@ Get informations about an identity document (passport, id cards)
|
|
118
123
|
```ruby
|
119
124
|
# load the gem
|
120
125
|
require 'yousign_client'
|
126
|
+
# setup authorization
|
127
|
+
YousignClient.configure do |config|
|
128
|
+
# Configure API key authorization: api_key
|
129
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
130
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
131
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
132
|
+
end
|
121
133
|
|
122
134
|
api_instance = YousignClient::CheckDocumentsApi.new
|
123
135
|
|
124
136
|
id = 'id_example' # String |
|
125
137
|
|
126
|
-
authorization = 'authorization_example' # String | Authentication credentials for HTTP authentication
|
127
|
-
|
128
138
|
|
129
139
|
begin
|
130
140
|
#Get informations about an identity document (passport, id cards)
|
131
|
-
result = api_instance.check_document_identities_id_get(id
|
141
|
+
result = api_instance.check_document_identities_id_get(id)
|
132
142
|
p result
|
133
143
|
rescue YousignClient::ApiError => e
|
134
144
|
puts "Exception when calling CheckDocumentsApi->check_document_identities_id_get: #{e}"
|
@@ -140,7 +150,6 @@ end
|
|
140
150
|
Name | Type | Description | Notes
|
141
151
|
------------- | ------------- | ------------- | -------------
|
142
152
|
**id** | **String**| |
|
143
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
144
153
|
|
145
154
|
### Return type
|
146
155
|
|
@@ -148,7 +157,7 @@ Name | Type | Description | Notes
|
|
148
157
|
|
149
158
|
### Authorization
|
150
159
|
|
151
|
-
|
160
|
+
[api_key](../README.md#api_key)
|
152
161
|
|
153
162
|
### HTTP request headers
|
154
163
|
|
@@ -158,7 +167,7 @@ No authorization required
|
|
158
167
|
|
159
168
|
|
160
169
|
# **check_document_identities_post**
|
161
|
-
> CheckDocumentIdentitiesOutput check_document_identities_post(
|
170
|
+
> CheckDocumentIdentitiesOutput check_document_identities_post(body)
|
162
171
|
|
163
172
|
Verify an identity document (passport, id cards)
|
164
173
|
|
@@ -166,19 +175,22 @@ Verify an identity document (passport, id cards)
|
|
166
175
|
```ruby
|
167
176
|
# load the gem
|
168
177
|
require 'yousign_client'
|
178
|
+
# setup authorization
|
179
|
+
YousignClient.configure do |config|
|
180
|
+
# Configure API key authorization: api_key
|
181
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
182
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
183
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
184
|
+
end
|
169
185
|
|
170
186
|
api_instance = YousignClient::CheckDocumentsApi.new
|
171
187
|
|
172
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
173
|
-
|
174
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
175
|
-
|
176
188
|
body = YousignClient::CheckDocumentIdentitiesInput.new # CheckDocumentIdentitiesInput |
|
177
189
|
|
178
190
|
|
179
191
|
begin
|
180
192
|
#Verify an identity document (passport, id cards)
|
181
|
-
result = api_instance.check_document_identities_post(
|
193
|
+
result = api_instance.check_document_identities_post(body)
|
182
194
|
p result
|
183
195
|
rescue YousignClient::ApiError => e
|
184
196
|
puts "Exception when calling CheckDocumentsApi->check_document_identities_post: #{e}"
|
@@ -189,8 +201,6 @@ end
|
|
189
201
|
|
190
202
|
Name | Type | Description | Notes
|
191
203
|
------------- | ------------- | ------------- | -------------
|
192
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
193
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
194
204
|
**body** | [**CheckDocumentIdentitiesInput**](CheckDocumentIdentitiesInput.md)| |
|
195
205
|
|
196
206
|
### Return type
|
@@ -199,7 +209,7 @@ Name | Type | Description | Notes
|
|
199
209
|
|
200
210
|
### Authorization
|
201
211
|
|
202
|
-
|
212
|
+
[api_key](../README.md#api_key)
|
203
213
|
|
204
214
|
### HTTP request headers
|
205
215
|
|