yousign_client 1.0.0 → 1.0.4
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/FileInput.md +1 -1
- data/docs/FileObjectsApi.md +40 -30
- data/docs/FilesApi.md +40 -30
- data/docs/MembersApi.md +50 -36
- data/docs/OperationsApi.md +20 -15
- data/docs/OrganizationsApi.md +11 -10
- data/docs/ProcedureOutput.md +1 -0
- 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/generate.sh +10 -0
- data/lib/yousign_client/api/authentications_api.rb +25 -88
- data/lib/yousign_client/api/check_documents_api.rb +17 -59
- data/lib/yousign_client/api/consent_processes_api.rb +33 -110
- data/lib/yousign_client/api/file_objects_api.rb +17 -59
- data/lib/yousign_client/api/files_api.rb +17 -59
- data/lib/yousign_client/api/members_api.rb +21 -70
- data/lib/yousign_client/api/operations_api.rb +9 -30
- data/lib/yousign_client/api/organizations_api.rb +5 -12
- data/lib/yousign_client/api/procedures_api.rb +37 -128
- data/lib/yousign_client/api/server_stamps_api.rb +9 -30
- data/lib/yousign_client/api/signature_u_is_api.rb +41 -153
- data/lib/yousign_client/api/user_groups_api.rb +9 -23
- data/lib/yousign_client/api/users_api.rb +21 -70
- data/lib/yousign_client/api/workspaces_api.rb +5 -12
- data/lib/yousign_client/api_client.rb +4 -4
- data/lib/yousign_client/api_error.rb +1 -1
- data/lib/yousign_client/configuration.rb +4 -4
- data/lib/yousign_client/models/authentication_email_output.rb +1 -1
- data/lib/yousign_client/models/authentication_inwebo_output.rb +1 -1
- data/lib/yousign_client/models/authentication_sms_output.rb +1 -1
- data/lib/yousign_client/models/body.rb +1 -1
- data/lib/yousign_client/models/body_1.rb +1 -1
- data/lib/yousign_client/models/body_2.rb +1 -1
- data/lib/yousign_client/models/check_document_bank_accounts_input.rb +1 -1
- data/lib/yousign_client/models/check_document_bank_accounts_output.rb +1 -16
- data/lib/yousign_client/models/check_document_identities_input.rb +1 -1
- data/lib/yousign_client/models/check_document_identities_output.rb +1 -16
- data/lib/yousign_client/models/config_email_template.rb +1 -1
- data/lib/yousign_client/models/config_webhook_template.rb +1 -1
- data/lib/yousign_client/models/consent_process_input.rb +1 -1
- data/lib/yousign_client/models/consent_process_output.rb +1 -1
- data/lib/yousign_client/models/consent_process_value_input.rb +1 -1
- data/lib/yousign_client/models/consent_process_value_output.rb +1 -1
- data/lib/yousign_client/models/file_input.rb +1 -3
- data/lib/yousign_client/models/file_input_metadata.rb +1 -1
- data/lib/yousign_client/models/file_object_input.rb +1 -16
- data/lib/yousign_client/models/file_object_input_without_file_reference.rb +1 -16
- data/lib/yousign_client/models/file_object_output.rb +1 -31
- data/lib/yousign_client/models/file_object_output_without_file_reference.rb +1 -31
- data/lib/yousign_client/models/file_output.rb +1 -31
- data/lib/yousign_client/models/inline_response_400.rb +1 -1
- data/lib/yousign_client/models/inwebo_user_request.rb +1 -16
- data/lib/yousign_client/models/member_input.rb +3 -3
- data/lib/yousign_client/models/member_output.rb +3 -18
- data/lib/yousign_client/models/mode_sms_configuration.rb +1 -1
- data/lib/yousign_client/models/operation_input.rb +1 -1
- data/lib/yousign_client/models/operation_output.rb +1 -1
- data/lib/yousign_client/models/operation_output_metadata.rb +1 -1
- data/lib/yousign_client/models/organization_billing_address.rb +1 -1
- data/lib/yousign_client/models/organization_output.rb +1 -16
- data/lib/yousign_client/models/procedure_config.rb +1 -1
- data/lib/yousign_client/models/procedure_config_email.rb +1 -1
- data/lib/yousign_client/models/procedure_config_reminder.rb +1 -1
- data/lib/yousign_client/models/procedure_config_reminder_config.rb +1 -1
- data/lib/yousign_client/models/procedure_config_reminder_config_email.rb +1 -1
- data/lib/yousign_client/models/procedure_config_webhook.rb +1 -1
- data/lib/yousign_client/models/procedure_duplicate_input.rb +1 -1
- data/lib/yousign_client/models/procedure_input.rb +1 -1
- data/lib/yousign_client/models/procedure_input_metadata.rb +1 -1
- data/lib/yousign_client/models/procedure_output.rb +12 -47
- data/lib/yousign_client/models/procedure_output_metadata.rb +1 -1
- data/lib/yousign_client/models/procedure_remind_config.rb +1 -1
- data/lib/yousign_client/models/procedure_remind_config_email.rb +1 -1
- data/lib/yousign_client/models/procedure_remind_input.rb +1 -1
- data/lib/yousign_client/models/server_stamp_config.rb +1 -1
- data/lib/yousign_client/models/server_stamp_config_webhook.rb +1 -1
- data/lib/yousign_client/models/server_stamp_input.rb +1 -1
- data/lib/yousign_client/models/server_stamp_output.rb +1 -1
- data/lib/yousign_client/models/signature_ui_input.rb +1 -1
- data/lib/yousign_client/models/signature_ui_input_redirect_cancel.rb +1 -1
- data/lib/yousign_client/models/signature_ui_input_redirect_error.rb +1 -1
- data/lib/yousign_client/models/signature_ui_input_redirect_success.rb +1 -1
- data/lib/yousign_client/models/signature_ui_input_update.rb +1 -1
- data/lib/yousign_client/models/signature_ui_label_input.rb +1 -1
- data/lib/yousign_client/models/signature_ui_label_input_included.rb +1 -1
- data/lib/yousign_client/models/signature_ui_label_output.rb +1 -1
- data/lib/yousign_client/models/signature_ui_output.rb +1 -1
- data/lib/yousign_client/models/signature_ui_output_redirect_cancel.rb +1 -1
- data/lib/yousign_client/models/signature_ui_output_redirect_error.rb +1 -1
- data/lib/yousign_client/models/signature_ui_output_redirect_success.rb +1 -1
- data/lib/yousign_client/models/user_group.rb +1 -16
- data/lib/yousign_client/models/user_input.rb +1 -1
- data/lib/yousign_client/models/user_input_notifications.rb +1 -1
- data/lib/yousign_client/models/user_output.rb +1 -16
- data/lib/yousign_client/models/user_output_notifications.rb +1 -1
- data/lib/yousign_client/models/user_workspace_output.rb +1 -16
- data/lib/yousign_client/models/workspace_config.rb +1 -1
- data/lib/yousign_client/models/workspace_config_email.rb +1 -1
- data/lib/yousign_client/models/workspace_config_procedure.rb +1 -1
- data/lib/yousign_client/models/workspace_output.rb +1 -16
- data/lib/yousign_client/version.rb +2 -2
- data/lib/yousign_client.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 +3 -2
- data/yousign_openapi.json +59 -706
- metadata +28 -7
data/docs/ConsentProcessesApi.md
CHANGED
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
|
15
15
|
|
16
16
|
|
17
17
|
# **consent_process_values_get**
|
18
|
-
> ConsentProcessValueOutput consent_process_values_get(member
|
18
|
+
> ConsentProcessValueOutput consent_process_values_get(member)
|
19
19
|
|
20
20
|
Get list of Consent Process Value
|
21
21
|
|
@@ -23,17 +23,22 @@ Get list of Consent Process Value
|
|
23
23
|
```ruby
|
24
24
|
# load the gem
|
25
25
|
require 'yousign_client'
|
26
|
+
# setup authorization
|
27
|
+
YousignClient.configure do |config|
|
28
|
+
# Configure API key authorization: api_key
|
29
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
32
|
+
end
|
26
33
|
|
27
34
|
api_instance = YousignClient::ConsentProcessesApi.new
|
28
35
|
|
29
36
|
member = '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member
|
30
37
|
|
31
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
32
|
-
|
33
38
|
|
34
39
|
begin
|
35
40
|
#Get list of Consent Process Value
|
36
|
-
result = api_instance.consent_process_values_get(member
|
41
|
+
result = api_instance.consent_process_values_get(member)
|
37
42
|
p result
|
38
43
|
rescue YousignClient::ApiError => e
|
39
44
|
puts "Exception when calling ConsentProcessesApi->consent_process_values_get: #{e}"
|
@@ -45,7 +50,6 @@ end
|
|
45
50
|
Name | Type | Description | Notes
|
46
51
|
------------- | ------------- | ------------- | -------------
|
47
52
|
**member** | **String**| id of member |
|
48
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
49
53
|
|
50
54
|
### Return type
|
51
55
|
|
@@ -53,7 +57,7 @@ Name | Type | Description | Notes
|
|
53
57
|
|
54
58
|
### Authorization
|
55
59
|
|
56
|
-
|
60
|
+
[api_key](../README.md#api_key)
|
57
61
|
|
58
62
|
### HTTP request headers
|
59
63
|
|
@@ -63,7 +67,7 @@ No authorization required
|
|
63
67
|
|
64
68
|
|
65
69
|
# **consent_process_values_id_get**
|
66
|
-
> ConsentProcessValueOutput consent_process_values_id_get(id,
|
70
|
+
> ConsentProcessValueOutput consent_process_values_id_get(id, opts)
|
67
71
|
|
68
72
|
Get a Consent Process Value
|
69
73
|
|
@@ -71,20 +75,25 @@ Get a Consent Process Value
|
|
71
75
|
```ruby
|
72
76
|
# load the gem
|
73
77
|
require 'yousign_client'
|
78
|
+
# setup authorization
|
79
|
+
YousignClient.configure do |config|
|
80
|
+
# Configure API key authorization: api_key
|
81
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
82
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
83
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
84
|
+
end
|
74
85
|
|
75
86
|
api_instance = YousignClient::ConsentProcessesApi.new
|
76
87
|
|
77
88
|
id = 'id_example' # String |
|
78
89
|
|
79
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
80
|
-
|
81
90
|
opts = {
|
82
91
|
member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member (required for anonymous)
|
83
92
|
}
|
84
93
|
|
85
94
|
begin
|
86
95
|
#Get a Consent Process Value
|
87
|
-
result = api_instance.consent_process_values_id_get(id,
|
96
|
+
result = api_instance.consent_process_values_id_get(id, opts)
|
88
97
|
p result
|
89
98
|
rescue YousignClient::ApiError => e
|
90
99
|
puts "Exception when calling ConsentProcessesApi->consent_process_values_id_get: #{e}"
|
@@ -96,7 +105,6 @@ end
|
|
96
105
|
Name | Type | Description | Notes
|
97
106
|
------------- | ------------- | ------------- | -------------
|
98
107
|
**id** | **String**| |
|
99
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
100
108
|
**member** | **String**| id of member (required for anonymous) | [optional]
|
101
109
|
|
102
110
|
### Return type
|
@@ -105,7 +113,7 @@ Name | Type | Description | Notes
|
|
105
113
|
|
106
114
|
### Authorization
|
107
115
|
|
108
|
-
|
116
|
+
[api_key](../README.md#api_key)
|
109
117
|
|
110
118
|
### HTTP request headers
|
111
119
|
|
@@ -115,7 +123,7 @@ No authorization required
|
|
115
123
|
|
116
124
|
|
117
125
|
# **consent_process_values_post**
|
118
|
-
> ConsentProcessValueOutput consent_process_values_post(
|
126
|
+
> ConsentProcessValueOutput consent_process_values_post(body)
|
119
127
|
|
120
128
|
Create a new Consent Process Value
|
121
129
|
|
@@ -123,19 +131,22 @@ Create a new Consent Process Value
|
|
123
131
|
```ruby
|
124
132
|
# load the gem
|
125
133
|
require 'yousign_client'
|
134
|
+
# setup authorization
|
135
|
+
YousignClient.configure do |config|
|
136
|
+
# Configure API key authorization: api_key
|
137
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
138
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
139
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
140
|
+
end
|
126
141
|
|
127
142
|
api_instance = YousignClient::ConsentProcessesApi.new
|
128
143
|
|
129
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
130
|
-
|
131
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
132
|
-
|
133
144
|
body = YousignClient::ConsentProcessValueInput.new # ConsentProcessValueInput |
|
134
145
|
|
135
146
|
|
136
147
|
begin
|
137
148
|
#Create a new Consent Process Value
|
138
|
-
result = api_instance.consent_process_values_post(
|
149
|
+
result = api_instance.consent_process_values_post(body)
|
139
150
|
p result
|
140
151
|
rescue YousignClient::ApiError => e
|
141
152
|
puts "Exception when calling ConsentProcessesApi->consent_process_values_post: #{e}"
|
@@ -146,8 +157,6 @@ end
|
|
146
157
|
|
147
158
|
Name | Type | Description | Notes
|
148
159
|
------------- | ------------- | ------------- | -------------
|
149
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
150
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
151
160
|
**body** | [**ConsentProcessValueInput**](ConsentProcessValueInput.md)| |
|
152
161
|
|
153
162
|
### Return type
|
@@ -156,7 +165,7 @@ Name | Type | Description | Notes
|
|
156
165
|
|
157
166
|
### Authorization
|
158
167
|
|
159
|
-
|
168
|
+
[api_key](../README.md#api_key)
|
160
169
|
|
161
170
|
### HTTP request headers
|
162
171
|
|
@@ -166,7 +175,7 @@ No authorization required
|
|
166
175
|
|
167
176
|
|
168
177
|
# **consent_processes_get**
|
169
|
-
> Array<ConsentProcessOutput> consent_processes_get(
|
178
|
+
> Array<ConsentProcessOutput> consent_processes_get(opts)
|
170
179
|
|
171
180
|
Get list of Consent Processes
|
172
181
|
|
@@ -174,11 +183,16 @@ Get list of Consent Processes
|
|
174
183
|
```ruby
|
175
184
|
# load the gem
|
176
185
|
require 'yousign_client'
|
186
|
+
# setup authorization
|
187
|
+
YousignClient.configure do |config|
|
188
|
+
# Configure API key authorization: api_key
|
189
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
191
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
192
|
+
end
|
177
193
|
|
178
194
|
api_instance = YousignClient::ConsentProcessesApi.new
|
179
195
|
|
180
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
181
|
-
|
182
196
|
opts = {
|
183
197
|
member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40', # String | id of member (required for anonymous)
|
184
198
|
procedure: '/procedures/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of procedure (required if the member attribut is not set)
|
@@ -186,7 +200,7 @@ opts = {
|
|
186
200
|
|
187
201
|
begin
|
188
202
|
#Get list of Consent Processes
|
189
|
-
result = api_instance.consent_processes_get(
|
203
|
+
result = api_instance.consent_processes_get(opts)
|
190
204
|
p result
|
191
205
|
rescue YousignClient::ApiError => e
|
192
206
|
puts "Exception when calling ConsentProcessesApi->consent_processes_get: #{e}"
|
@@ -197,7 +211,6 @@ end
|
|
197
211
|
|
198
212
|
Name | Type | Description | Notes
|
199
213
|
------------- | ------------- | ------------- | -------------
|
200
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
201
214
|
**member** | **String**| id of member (required for anonymous) | [optional]
|
202
215
|
**procedure** | **String**| id of procedure (required if the member attribut is not set) | [optional]
|
203
216
|
|
@@ -207,7 +220,7 @@ Name | Type | Description | Notes
|
|
207
220
|
|
208
221
|
### Authorization
|
209
222
|
|
210
|
-
|
223
|
+
[api_key](../README.md#api_key)
|
211
224
|
|
212
225
|
### HTTP request headers
|
213
226
|
|
@@ -217,7 +230,7 @@ No authorization required
|
|
217
230
|
|
218
231
|
|
219
232
|
# **consent_processes_id_delete**
|
220
|
-
> consent_processes_id_delete(id
|
233
|
+
> consent_processes_id_delete(id)
|
221
234
|
|
222
235
|
Delete a Consent Process
|
223
236
|
|
@@ -225,17 +238,22 @@ Delete a Consent Process
|
|
225
238
|
```ruby
|
226
239
|
# load the gem
|
227
240
|
require 'yousign_client'
|
241
|
+
# setup authorization
|
242
|
+
YousignClient.configure do |config|
|
243
|
+
# Configure API key authorization: api_key
|
244
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
245
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
246
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
247
|
+
end
|
228
248
|
|
229
249
|
api_instance = YousignClient::ConsentProcessesApi.new
|
230
250
|
|
231
251
|
id = 'id_example' # String |
|
232
252
|
|
233
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
234
|
-
|
235
253
|
|
236
254
|
begin
|
237
255
|
#Delete a Consent Process
|
238
|
-
api_instance.consent_processes_id_delete(id
|
256
|
+
api_instance.consent_processes_id_delete(id)
|
239
257
|
rescue YousignClient::ApiError => e
|
240
258
|
puts "Exception when calling ConsentProcessesApi->consent_processes_id_delete: #{e}"
|
241
259
|
end
|
@@ -246,7 +264,6 @@ end
|
|
246
264
|
Name | Type | Description | Notes
|
247
265
|
------------- | ------------- | ------------- | -------------
|
248
266
|
**id** | **String**| |
|
249
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
250
267
|
|
251
268
|
### Return type
|
252
269
|
|
@@ -254,7 +271,7 @@ nil (empty response body)
|
|
254
271
|
|
255
272
|
### Authorization
|
256
273
|
|
257
|
-
|
274
|
+
[api_key](../README.md#api_key)
|
258
275
|
|
259
276
|
### HTTP request headers
|
260
277
|
|
@@ -264,7 +281,7 @@ No authorization required
|
|
264
281
|
|
265
282
|
|
266
283
|
# **consent_processes_id_get**
|
267
|
-
> ConsentProcessOutput consent_processes_id_get(id,
|
284
|
+
> ConsentProcessOutput consent_processes_id_get(id, opts)
|
268
285
|
|
269
286
|
Get a Consent Process
|
270
287
|
|
@@ -272,20 +289,25 @@ Get a Consent Process
|
|
272
289
|
```ruby
|
273
290
|
# load the gem
|
274
291
|
require 'yousign_client'
|
292
|
+
# setup authorization
|
293
|
+
YousignClient.configure do |config|
|
294
|
+
# Configure API key authorization: api_key
|
295
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
296
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
297
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
298
|
+
end
|
275
299
|
|
276
300
|
api_instance = YousignClient::ConsentProcessesApi.new
|
277
301
|
|
278
302
|
id = 'id_example' # String |
|
279
303
|
|
280
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
281
|
-
|
282
304
|
opts = {
|
283
305
|
member: '/members/17625df4-4ee7-498e-822d-3637c91b6f40' # String | id of member (required for anonymous)
|
284
306
|
}
|
285
307
|
|
286
308
|
begin
|
287
309
|
#Get a Consent Process
|
288
|
-
result = api_instance.consent_processes_id_get(id,
|
310
|
+
result = api_instance.consent_processes_id_get(id, opts)
|
289
311
|
p result
|
290
312
|
rescue YousignClient::ApiError => e
|
291
313
|
puts "Exception when calling ConsentProcessesApi->consent_processes_id_get: #{e}"
|
@@ -297,7 +319,6 @@ end
|
|
297
319
|
Name | Type | Description | Notes
|
298
320
|
------------- | ------------- | ------------- | -------------
|
299
321
|
**id** | **String**| |
|
300
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
301
322
|
**member** | **String**| id of member (required for anonymous) | [optional]
|
302
323
|
|
303
324
|
### Return type
|
@@ -306,7 +327,7 @@ Name | Type | Description | Notes
|
|
306
327
|
|
307
328
|
### Authorization
|
308
329
|
|
309
|
-
|
330
|
+
[api_key](../README.md#api_key)
|
310
331
|
|
311
332
|
### HTTP request headers
|
312
333
|
|
@@ -316,7 +337,7 @@ No authorization required
|
|
316
337
|
|
317
338
|
|
318
339
|
# **consent_processes_id_put**
|
319
|
-
> ConsentProcessOutput consent_processes_id_put(
|
340
|
+
> ConsentProcessOutput consent_processes_id_put(idbody)
|
320
341
|
|
321
342
|
Update a Consent Process
|
322
343
|
|
@@ -324,21 +345,24 @@ Update a Consent Process
|
|
324
345
|
```ruby
|
325
346
|
# load the gem
|
326
347
|
require 'yousign_client'
|
348
|
+
# setup authorization
|
349
|
+
YousignClient.configure do |config|
|
350
|
+
# Configure API key authorization: api_key
|
351
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
352
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
353
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
354
|
+
end
|
327
355
|
|
328
356
|
api_instance = YousignClient::ConsentProcessesApi.new
|
329
357
|
|
330
358
|
id = 'id_example' # String |
|
331
359
|
|
332
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
333
|
-
|
334
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
335
|
-
|
336
360
|
body = YousignClient::ConsentProcessInput.new # ConsentProcessInput |
|
337
361
|
|
338
362
|
|
339
363
|
begin
|
340
364
|
#Update a Consent Process
|
341
|
-
result = api_instance.consent_processes_id_put(
|
365
|
+
result = api_instance.consent_processes_id_put(idbody)
|
342
366
|
p result
|
343
367
|
rescue YousignClient::ApiError => e
|
344
368
|
puts "Exception when calling ConsentProcessesApi->consent_processes_id_put: #{e}"
|
@@ -350,8 +374,6 @@ end
|
|
350
374
|
Name | Type | Description | Notes
|
351
375
|
------------- | ------------- | ------------- | -------------
|
352
376
|
**id** | **String**| |
|
353
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
354
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
355
377
|
**body** | [**ConsentProcessInput**](ConsentProcessInput.md)| |
|
356
378
|
|
357
379
|
### Return type
|
@@ -360,7 +382,7 @@ Name | Type | Description | Notes
|
|
360
382
|
|
361
383
|
### Authorization
|
362
384
|
|
363
|
-
|
385
|
+
[api_key](../README.md#api_key)
|
364
386
|
|
365
387
|
### HTTP request headers
|
366
388
|
|
@@ -370,7 +392,7 @@ No authorization required
|
|
370
392
|
|
371
393
|
|
372
394
|
# **consent_processes_post**
|
373
|
-
> ConsentProcessOutput consent_processes_post(
|
395
|
+
> ConsentProcessOutput consent_processes_post(body)
|
374
396
|
|
375
397
|
Create a new Consent Process
|
376
398
|
|
@@ -378,19 +400,22 @@ Create a new Consent Process
|
|
378
400
|
```ruby
|
379
401
|
# load the gem
|
380
402
|
require 'yousign_client'
|
403
|
+
# setup authorization
|
404
|
+
YousignClient.configure do |config|
|
405
|
+
# Configure API key authorization: api_key
|
406
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
407
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
408
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
409
|
+
end
|
381
410
|
|
382
411
|
api_instance = YousignClient::ConsentProcessesApi.new
|
383
412
|
|
384
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
385
|
-
|
386
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
387
|
-
|
388
413
|
body = YousignClient::ConsentProcessInput.new # ConsentProcessInput |
|
389
414
|
|
390
415
|
|
391
416
|
begin
|
392
417
|
#Create a new Consent Process
|
393
|
-
result = api_instance.consent_processes_post(
|
418
|
+
result = api_instance.consent_processes_post(body)
|
394
419
|
p result
|
395
420
|
rescue YousignClient::ApiError => e
|
396
421
|
puts "Exception when calling ConsentProcessesApi->consent_processes_post: #{e}"
|
@@ -401,8 +426,6 @@ end
|
|
401
426
|
|
402
427
|
Name | Type | Description | Notes
|
403
428
|
------------- | ------------- | ------------- | -------------
|
404
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
405
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
406
429
|
**body** | [**ConsentProcessInput**](ConsentProcessInput.md)| |
|
407
430
|
|
408
431
|
### Return type
|
@@ -411,7 +434,7 @@ Name | Type | Description | Notes
|
|
411
434
|
|
412
435
|
### Authorization
|
413
436
|
|
414
|
-
|
437
|
+
[api_key](../README.md#api_key)
|
415
438
|
|
416
439
|
### HTTP request headers
|
417
440
|
|
data/docs/FileInput.md
CHANGED
@@ -10,6 +10,6 @@ Name | Type | Description | Notes
|
|
10
10
|
**metadata** | [**FileInputMetadata**](FileInputMetadata.md) | | [optional]
|
11
11
|
**content** | **String** | Content in base 64 of the file | [optional]
|
12
12
|
**procedure** | **String** | Id of the procedure | [optional]
|
13
|
-
**position** | **Integer** | | [optional]
|
13
|
+
**position** | **Integer** | | [optional]
|
14
14
|
|
15
15
|
|
data/docs/FileObjectsApi.md
CHANGED
@@ -11,7 +11,7 @@ Method | HTTP request | Description
|
|
11
11
|
|
12
12
|
|
13
13
|
# **file_objects_id_delete**
|
14
|
-
> file_objects_id_delete(id
|
14
|
+
> file_objects_id_delete(id)
|
15
15
|
|
16
16
|
Delete a File Object
|
17
17
|
|
@@ -21,17 +21,22 @@ Delete a File Object
|
|
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::FileObjectsApi.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
|
#Delete a File Object
|
34
|
-
api_instance.file_objects_id_delete(id
|
39
|
+
api_instance.file_objects_id_delete(id)
|
35
40
|
rescue YousignClient::ApiError => e
|
36
41
|
puts "Exception when calling FileObjectsApi->file_objects_id_delete: #{e}"
|
37
42
|
end
|
@@ -42,7 +47,6 @@ end
|
|
42
47
|
Name | Type | Description | Notes
|
43
48
|
------------- | ------------- | ------------- | -------------
|
44
49
|
**id** | **String**| |
|
45
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
46
50
|
|
47
51
|
### Return type
|
48
52
|
|
@@ -50,7 +54,7 @@ nil (empty response body)
|
|
50
54
|
|
51
55
|
### Authorization
|
52
56
|
|
53
|
-
|
57
|
+
[api_key](../README.md#api_key)
|
54
58
|
|
55
59
|
### HTTP request headers
|
56
60
|
|
@@ -60,7 +64,7 @@ No authorization required
|
|
60
64
|
|
61
65
|
|
62
66
|
# **file_objects_id_get**
|
63
|
-
> FileObjectOutput file_objects_id_get(id
|
67
|
+
> FileObjectOutput file_objects_id_get(id)
|
64
68
|
|
65
69
|
Find a File Object by ID
|
66
70
|
|
@@ -70,17 +74,22 @@ Get a File Object
|
|
70
74
|
```ruby
|
71
75
|
# load the gem
|
72
76
|
require 'yousign_client'
|
77
|
+
# setup authorization
|
78
|
+
YousignClient.configure do |config|
|
79
|
+
# Configure API key authorization: api_key
|
80
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
81
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
83
|
+
end
|
73
84
|
|
74
85
|
api_instance = YousignClient::FileObjectsApi.new
|
75
86
|
|
76
87
|
id = 'id_example' # String |
|
77
88
|
|
78
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
79
|
-
|
80
89
|
|
81
90
|
begin
|
82
91
|
#Find a File Object by ID
|
83
|
-
result = api_instance.file_objects_id_get(id
|
92
|
+
result = api_instance.file_objects_id_get(id)
|
84
93
|
p result
|
85
94
|
rescue YousignClient::ApiError => e
|
86
95
|
puts "Exception when calling FileObjectsApi->file_objects_id_get: #{e}"
|
@@ -92,7 +101,6 @@ end
|
|
92
101
|
Name | Type | Description | Notes
|
93
102
|
------------- | ------------- | ------------- | -------------
|
94
103
|
**id** | **String**| |
|
95
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
96
104
|
|
97
105
|
### Return type
|
98
106
|
|
@@ -100,7 +108,7 @@ Name | Type | Description | Notes
|
|
100
108
|
|
101
109
|
### Authorization
|
102
110
|
|
103
|
-
|
111
|
+
[api_key](../README.md#api_key)
|
104
112
|
|
105
113
|
### HTTP request headers
|
106
114
|
|
@@ -110,7 +118,7 @@ No authorization required
|
|
110
118
|
|
111
119
|
|
112
120
|
# **file_objects_id_put**
|
113
|
-
> FileObjectOutput file_objects_id_put(
|
121
|
+
> FileObjectOutput file_objects_id_put(idbody)
|
114
122
|
|
115
123
|
Update a File Object
|
116
124
|
|
@@ -120,21 +128,24 @@ Update a File Object
|
|
120
128
|
```ruby
|
121
129
|
# load the gem
|
122
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
|
123
138
|
|
124
139
|
api_instance = YousignClient::FileObjectsApi.new
|
125
140
|
|
126
141
|
id = 'id_example' # String |
|
127
142
|
|
128
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
129
|
-
|
130
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
131
|
-
|
132
143
|
body = YousignClient::FileObjectInput.new # FileObjectInput |
|
133
144
|
|
134
145
|
|
135
146
|
begin
|
136
147
|
#Update a File Object
|
137
|
-
result = api_instance.file_objects_id_put(
|
148
|
+
result = api_instance.file_objects_id_put(idbody)
|
138
149
|
p result
|
139
150
|
rescue YousignClient::ApiError => e
|
140
151
|
puts "Exception when calling FileObjectsApi->file_objects_id_put: #{e}"
|
@@ -146,8 +157,6 @@ end
|
|
146
157
|
Name | Type | Description | Notes
|
147
158
|
------------- | ------------- | ------------- | -------------
|
148
159
|
**id** | **String**| |
|
149
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
150
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
151
160
|
**body** | [**FileObjectInput**](FileObjectInput.md)| |
|
152
161
|
|
153
162
|
### Return type
|
@@ -156,7 +165,7 @@ Name | Type | Description | Notes
|
|
156
165
|
|
157
166
|
### Authorization
|
158
167
|
|
159
|
-
|
168
|
+
[api_key](../README.md#api_key)
|
160
169
|
|
161
170
|
### HTTP request headers
|
162
171
|
|
@@ -166,7 +175,7 @@ No authorization required
|
|
166
175
|
|
167
176
|
|
168
177
|
# **file_objects_post**
|
169
|
-
> FileObjectOutput file_objects_post(
|
178
|
+
> FileObjectOutput file_objects_post(body)
|
170
179
|
|
171
180
|
Create a new File Object
|
172
181
|
|
@@ -176,19 +185,22 @@ Create a new fileObject
|
|
176
185
|
```ruby
|
177
186
|
# load the gem
|
178
187
|
require 'yousign_client'
|
188
|
+
# setup authorization
|
189
|
+
YousignClient.configure do |config|
|
190
|
+
# Configure API key authorization: api_key
|
191
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
192
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
193
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
194
|
+
end
|
179
195
|
|
180
196
|
api_instance = YousignClient::FileObjectsApi.new
|
181
197
|
|
182
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
183
|
-
|
184
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
185
|
-
|
186
198
|
body = YousignClient::FileObjectInput.new # FileObjectInput |
|
187
199
|
|
188
200
|
|
189
201
|
begin
|
190
202
|
#Create a new File Object
|
191
|
-
result = api_instance.file_objects_post(
|
203
|
+
result = api_instance.file_objects_post(body)
|
192
204
|
p result
|
193
205
|
rescue YousignClient::ApiError => e
|
194
206
|
puts "Exception when calling FileObjectsApi->file_objects_post: #{e}"
|
@@ -199,8 +211,6 @@ end
|
|
199
211
|
|
200
212
|
Name | Type | Description | Notes
|
201
213
|
------------- | ------------- | ------------- | -------------
|
202
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
203
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
204
214
|
**body** | [**FileObjectInput**](FileObjectInput.md)| |
|
205
215
|
|
206
216
|
### Return type
|
@@ -209,7 +219,7 @@ Name | Type | Description | Notes
|
|
209
219
|
|
210
220
|
### Authorization
|
211
221
|
|
212
|
-
|
222
|
+
[api_key](../README.md#api_key)
|
213
223
|
|
214
224
|
### HTTP request headers
|
215
225
|
|