yousign_client 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
data/docs/OperationsApi.md
CHANGED
@@ -9,7 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
|
10
10
|
|
11
11
|
# **operations_id_get**
|
12
|
-
> OperationOutput operations_id_get(id
|
12
|
+
> OperationOutput operations_id_get(id)
|
13
13
|
|
14
14
|
Find an Operation by ID
|
15
15
|
|
@@ -17,17 +17,22 @@ Find an Operation by ID
|
|
17
17
|
```ruby
|
18
18
|
# load the gem
|
19
19
|
require 'yousign_client'
|
20
|
+
# setup authorization
|
21
|
+
YousignClient.configure do |config|
|
22
|
+
# Configure API key authorization: api_key
|
23
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
24
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
25
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
26
|
+
end
|
20
27
|
|
21
28
|
api_instance = YousignClient::OperationsApi.new
|
22
29
|
|
23
30
|
id = 'id_example' # String |
|
24
31
|
|
25
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
26
|
-
|
27
32
|
|
28
33
|
begin
|
29
34
|
#Find an Operation by ID
|
30
|
-
result = api_instance.operations_id_get(id
|
35
|
+
result = api_instance.operations_id_get(id)
|
31
36
|
p result
|
32
37
|
rescue YousignClient::ApiError => e
|
33
38
|
puts "Exception when calling OperationsApi->operations_id_get: #{e}"
|
@@ -39,7 +44,6 @@ end
|
|
39
44
|
Name | Type | Description | Notes
|
40
45
|
------------- | ------------- | ------------- | -------------
|
41
46
|
**id** | **String**| |
|
42
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
43
47
|
|
44
48
|
### Return type
|
45
49
|
|
@@ -47,7 +51,7 @@ Name | Type | Description | Notes
|
|
47
51
|
|
48
52
|
### Authorization
|
49
53
|
|
50
|
-
|
54
|
+
[api_key](../README.md#api_key)
|
51
55
|
|
52
56
|
### HTTP request headers
|
53
57
|
|
@@ -57,7 +61,7 @@ No authorization required
|
|
57
61
|
|
58
62
|
|
59
63
|
# **operations_post**
|
60
|
-
> OperationOutput operations_post(
|
64
|
+
> OperationOutput operations_post(body)
|
61
65
|
|
62
66
|
Create a new Operation
|
63
67
|
|
@@ -65,19 +69,22 @@ Create a new Operation
|
|
65
69
|
```ruby
|
66
70
|
# load the gem
|
67
71
|
require 'yousign_client'
|
72
|
+
# setup authorization
|
73
|
+
YousignClient.configure do |config|
|
74
|
+
# Configure API key authorization: api_key
|
75
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
76
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
77
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
78
|
+
end
|
68
79
|
|
69
80
|
api_instance = YousignClient::OperationsApi.new
|
70
81
|
|
71
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
72
|
-
|
73
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
74
|
-
|
75
82
|
body = YousignClient::OperationInput.new # OperationInput |
|
76
83
|
|
77
84
|
|
78
85
|
begin
|
79
86
|
#Create a new Operation
|
80
|
-
result = api_instance.operations_post(
|
87
|
+
result = api_instance.operations_post(body)
|
81
88
|
p result
|
82
89
|
rescue YousignClient::ApiError => e
|
83
90
|
puts "Exception when calling OperationsApi->operations_post: #{e}"
|
@@ -88,8 +95,6 @@ end
|
|
88
95
|
|
89
96
|
Name | Type | Description | Notes
|
90
97
|
------------- | ------------- | ------------- | -------------
|
91
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
92
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
93
98
|
**body** | [**OperationInput**](OperationInput.md)| |
|
94
99
|
|
95
100
|
### Return type
|
@@ -98,7 +103,7 @@ Name | Type | Description | Notes
|
|
98
103
|
|
99
104
|
### Authorization
|
100
105
|
|
101
|
-
|
106
|
+
[api_key](../README.md#api_key)
|
102
107
|
|
103
108
|
### HTTP request headers
|
104
109
|
|
data/docs/OrganizationsApi.md
CHANGED
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
|
8
8
|
|
9
9
|
|
10
10
|
# **organizations_get**
|
11
|
-
> Array<OrganizationOutput> organizations_get
|
11
|
+
> Array<OrganizationOutput> organizations_get
|
12
12
|
|
13
13
|
List all Organizations
|
14
14
|
|
@@ -16,15 +16,19 @@ List all Organizations
|
|
16
16
|
```ruby
|
17
17
|
# load the gem
|
18
18
|
require 'yousign_client'
|
19
|
+
# setup authorization
|
20
|
+
YousignClient.configure do |config|
|
21
|
+
# Configure API key authorization: api_key
|
22
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
23
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
24
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
25
|
+
end
|
19
26
|
|
20
27
|
api_instance = YousignClient::OrganizationsApi.new
|
21
28
|
|
22
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
23
|
-
|
24
|
-
|
25
29
|
begin
|
26
30
|
#List all Organizations
|
27
|
-
result = api_instance.organizations_get
|
31
|
+
result = api_instance.organizations_get
|
28
32
|
p result
|
29
33
|
rescue YousignClient::ApiError => e
|
30
34
|
puts "Exception when calling OrganizationsApi->organizations_get: #{e}"
|
@@ -32,10 +36,7 @@ end
|
|
32
36
|
```
|
33
37
|
|
34
38
|
### Parameters
|
35
|
-
|
36
|
-
Name | Type | Description | Notes
|
37
|
-
------------- | ------------- | ------------- | -------------
|
38
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
39
|
+
This endpoint does not need any parameter.
|
39
40
|
|
40
41
|
### Return type
|
41
42
|
|
@@ -43,7 +44,7 @@ Name | Type | Description | Notes
|
|
43
44
|
|
44
45
|
### Authorization
|
45
46
|
|
46
|
-
|
47
|
+
[api_key](../README.md#api_key)
|
47
48
|
|
48
49
|
### HTTP request headers
|
49
50
|
|
data/docs/ProceduresApi.md
CHANGED
@@ -16,7 +16,7 @@ Method | HTTP request | Description
|
|
16
16
|
|
17
17
|
|
18
18
|
# **export_procedures_get**
|
19
|
-
> String export_procedures_get(
|
19
|
+
> String export_procedures_get(opts)
|
20
20
|
|
21
21
|
Export Procedure list
|
22
22
|
|
@@ -24,11 +24,16 @@ Export Procedure list
|
|
24
24
|
```ruby
|
25
25
|
# load the gem
|
26
26
|
require 'yousign_client'
|
27
|
+
# setup authorization
|
28
|
+
YousignClient.configure do |config|
|
29
|
+
# Configure API key authorization: api_key
|
30
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
33
|
+
end
|
27
34
|
|
28
35
|
api_instance = YousignClient::ProceduresApi.new
|
29
36
|
|
30
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
31
|
-
|
32
37
|
opts = {
|
33
38
|
status: 'status_example', # String | Return Procedure list based on the status for each Procedure
|
34
39
|
name: 'test', # String | Filter by name (contains)
|
@@ -46,7 +51,7 @@ opts = {
|
|
46
51
|
|
47
52
|
begin
|
48
53
|
#Export Procedure list
|
49
|
-
result = api_instance.export_procedures_get(
|
54
|
+
result = api_instance.export_procedures_get(opts)
|
50
55
|
p result
|
51
56
|
rescue YousignClient::ApiError => e
|
52
57
|
puts "Exception when calling ProceduresApi->export_procedures_get: #{e}"
|
@@ -57,7 +62,6 @@ end
|
|
57
62
|
|
58
63
|
Name | Type | Description | Notes
|
59
64
|
------------- | ------------- | ------------- | -------------
|
60
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
61
65
|
**status** | **String**| Return Procedure list based on the status for each Procedure | [optional]
|
62
66
|
**name** | **String**| Filter by name (contains) | [optional]
|
63
67
|
**members_firstname** | **String**| Filter by member firstname (contains) | [optional]
|
@@ -77,7 +81,7 @@ Name | Type | Description | Notes
|
|
77
81
|
|
78
82
|
### Authorization
|
79
83
|
|
80
|
-
|
84
|
+
[api_key](../README.md#api_key)
|
81
85
|
|
82
86
|
### HTTP request headers
|
83
87
|
|
@@ -87,7 +91,7 @@ No authorization required
|
|
87
91
|
|
88
92
|
|
89
93
|
# **procedures_get**
|
90
|
-
> Array<ProcedureOutput> procedures_get(
|
94
|
+
> Array<ProcedureOutput> procedures_get(opts)
|
91
95
|
|
92
96
|
Get Procedure list
|
93
97
|
|
@@ -95,11 +99,16 @@ Get Procedure list
|
|
95
99
|
```ruby
|
96
100
|
# load the gem
|
97
101
|
require 'yousign_client'
|
102
|
+
# setup authorization
|
103
|
+
YousignClient.configure do |config|
|
104
|
+
# Configure API key authorization: api_key
|
105
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
106
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
107
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
108
|
+
end
|
98
109
|
|
99
110
|
api_instance = YousignClient::ProceduresApi.new
|
100
111
|
|
101
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
102
|
-
|
103
112
|
opts = {
|
104
113
|
status: 'status_example', # String | Return Procedure list based on the status for each Procedure
|
105
114
|
template: false, # BOOLEAN | Used to get Procedure template list
|
@@ -122,7 +131,7 @@ opts = {
|
|
122
131
|
|
123
132
|
begin
|
124
133
|
#Get Procedure list
|
125
|
-
result = api_instance.procedures_get(
|
134
|
+
result = api_instance.procedures_get(opts)
|
126
135
|
p result
|
127
136
|
rescue YousignClient::ApiError => e
|
128
137
|
puts "Exception when calling ProceduresApi->procedures_get: #{e}"
|
@@ -133,7 +142,6 @@ end
|
|
133
142
|
|
134
143
|
Name | Type | Description | Notes
|
135
144
|
------------- | ------------- | ------------- | -------------
|
136
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
137
145
|
**status** | **String**| Return Procedure list based on the status for each Procedure | [optional]
|
138
146
|
**template** | **BOOLEAN**| Used to get Procedure template list | [optional] [default to false]
|
139
147
|
**members** | [**Array<String>**](String.md)| Get Procedure list for given members (paraph mode) | [optional]
|
@@ -158,7 +166,7 @@ Name | Type | Description | Notes
|
|
158
166
|
|
159
167
|
### Authorization
|
160
168
|
|
161
|
-
|
169
|
+
[api_key](../README.md#api_key)
|
162
170
|
|
163
171
|
### HTTP request headers
|
164
172
|
|
@@ -168,7 +176,7 @@ No authorization required
|
|
168
176
|
|
169
177
|
|
170
178
|
# **procedures_id_delete**
|
171
|
-
> procedures_id_delete(id
|
179
|
+
> procedures_id_delete(id)
|
172
180
|
|
173
181
|
Delete a Procedure
|
174
182
|
|
@@ -176,17 +184,22 @@ Delete a Procedure
|
|
176
184
|
```ruby
|
177
185
|
# load the gem
|
178
186
|
require 'yousign_client'
|
187
|
+
# setup authorization
|
188
|
+
YousignClient.configure do |config|
|
189
|
+
# Configure API key authorization: api_key
|
190
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
191
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
192
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
193
|
+
end
|
179
194
|
|
180
195
|
api_instance = YousignClient::ProceduresApi.new
|
181
196
|
|
182
197
|
id = 'id_example' # String |
|
183
198
|
|
184
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
185
|
-
|
186
199
|
|
187
200
|
begin
|
188
201
|
#Delete a Procedure
|
189
|
-
api_instance.procedures_id_delete(id
|
202
|
+
api_instance.procedures_id_delete(id)
|
190
203
|
rescue YousignClient::ApiError => e
|
191
204
|
puts "Exception when calling ProceduresApi->procedures_id_delete: #{e}"
|
192
205
|
end
|
@@ -197,7 +210,6 @@ end
|
|
197
210
|
Name | Type | Description | Notes
|
198
211
|
------------- | ------------- | ------------- | -------------
|
199
212
|
**id** | **String**| |
|
200
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
201
213
|
|
202
214
|
### Return type
|
203
215
|
|
@@ -205,7 +217,7 @@ nil (empty response body)
|
|
205
217
|
|
206
218
|
### Authorization
|
207
219
|
|
208
|
-
|
220
|
+
[api_key](../README.md#api_key)
|
209
221
|
|
210
222
|
### HTTP request headers
|
211
223
|
|
@@ -215,7 +227,7 @@ No authorization required
|
|
215
227
|
|
216
228
|
|
217
229
|
# **procedures_id_duplicate_post**
|
218
|
-
> ProcedureOutput procedures_id_duplicate_post(id,
|
230
|
+
> ProcedureOutput procedures_id_duplicate_post(id, body)
|
219
231
|
|
220
232
|
Duplicate a Procedure
|
221
233
|
|
@@ -223,21 +235,24 @@ Duplicate a Procedure
|
|
223
235
|
```ruby
|
224
236
|
# load the gem
|
225
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
|
226
245
|
|
227
246
|
api_instance = YousignClient::ProceduresApi.new
|
228
247
|
|
229
248
|
id = 'id_example' # String |
|
230
249
|
|
231
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
232
|
-
|
233
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
234
|
-
|
235
250
|
body = YousignClient::ProcedureDuplicateInput.new # ProcedureDuplicateInput |
|
236
251
|
|
237
252
|
|
238
253
|
begin
|
239
254
|
#Duplicate a Procedure
|
240
|
-
result = api_instance.procedures_id_duplicate_post(id,
|
255
|
+
result = api_instance.procedures_id_duplicate_post(id, body)
|
241
256
|
p result
|
242
257
|
rescue YousignClient::ApiError => e
|
243
258
|
puts "Exception when calling ProceduresApi->procedures_id_duplicate_post: #{e}"
|
@@ -249,8 +264,6 @@ end
|
|
249
264
|
Name | Type | Description | Notes
|
250
265
|
------------- | ------------- | ------------- | -------------
|
251
266
|
**id** | **String**| |
|
252
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
253
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
254
267
|
**body** | [**ProcedureDuplicateInput**](ProcedureDuplicateInput.md)| |
|
255
268
|
|
256
269
|
### Return type
|
@@ -259,7 +272,7 @@ Name | Type | Description | Notes
|
|
259
272
|
|
260
273
|
### Authorization
|
261
274
|
|
262
|
-
|
275
|
+
[api_key](../README.md#api_key)
|
263
276
|
|
264
277
|
### HTTP request headers
|
265
278
|
|
@@ -269,7 +282,7 @@ No authorization required
|
|
269
282
|
|
270
283
|
|
271
284
|
# **procedures_id_get**
|
272
|
-
> ProcedureOutput procedures_id_get(id
|
285
|
+
> ProcedureOutput procedures_id_get(id)
|
273
286
|
|
274
287
|
Find a Procedure by ID
|
275
288
|
|
@@ -277,17 +290,22 @@ Find a Procedure by ID
|
|
277
290
|
```ruby
|
278
291
|
# load the gem
|
279
292
|
require 'yousign_client'
|
293
|
+
# setup authorization
|
294
|
+
YousignClient.configure do |config|
|
295
|
+
# Configure API key authorization: api_key
|
296
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
297
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
298
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
299
|
+
end
|
280
300
|
|
281
301
|
api_instance = YousignClient::ProceduresApi.new
|
282
302
|
|
283
303
|
id = 'id_example' # String |
|
284
304
|
|
285
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
286
|
-
|
287
305
|
|
288
306
|
begin
|
289
307
|
#Find a Procedure by ID
|
290
|
-
result = api_instance.procedures_id_get(id
|
308
|
+
result = api_instance.procedures_id_get(id)
|
291
309
|
p result
|
292
310
|
rescue YousignClient::ApiError => e
|
293
311
|
puts "Exception when calling ProceduresApi->procedures_id_get: #{e}"
|
@@ -299,7 +317,6 @@ end
|
|
299
317
|
Name | Type | Description | Notes
|
300
318
|
------------- | ------------- | ------------- | -------------
|
301
319
|
**id** | **String**| |
|
302
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
303
320
|
|
304
321
|
### Return type
|
305
322
|
|
@@ -307,7 +324,7 @@ Name | Type | Description | Notes
|
|
307
324
|
|
308
325
|
### Authorization
|
309
326
|
|
310
|
-
|
327
|
+
[api_key](../README.md#api_key)
|
311
328
|
|
312
329
|
### HTTP request headers
|
313
330
|
|
@@ -317,7 +334,7 @@ No authorization required
|
|
317
334
|
|
318
335
|
|
319
336
|
# **procedures_id_proof_get**
|
320
|
-
> String procedures_id_proof_get(id
|
337
|
+
> String procedures_id_proof_get(id)
|
321
338
|
|
322
339
|
Get a Procedure proof file
|
323
340
|
|
@@ -327,17 +344,22 @@ Get a Procedure proof file
|
|
327
344
|
```ruby
|
328
345
|
# load the gem
|
329
346
|
require 'yousign_client'
|
347
|
+
# setup authorization
|
348
|
+
YousignClient.configure do |config|
|
349
|
+
# Configure API key authorization: api_key
|
350
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
351
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
352
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
353
|
+
end
|
330
354
|
|
331
355
|
api_instance = YousignClient::ProceduresApi.new
|
332
356
|
|
333
357
|
id = 'id_example' # String |
|
334
358
|
|
335
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
336
|
-
|
337
359
|
|
338
360
|
begin
|
339
361
|
#Get a Procedure proof file
|
340
|
-
result = api_instance.procedures_id_proof_get(id
|
362
|
+
result = api_instance.procedures_id_proof_get(id)
|
341
363
|
p result
|
342
364
|
rescue YousignClient::ApiError => e
|
343
365
|
puts "Exception when calling ProceduresApi->procedures_id_proof_get: #{e}"
|
@@ -349,7 +371,6 @@ end
|
|
349
371
|
Name | Type | Description | Notes
|
350
372
|
------------- | ------------- | ------------- | -------------
|
351
373
|
**id** | **String**| |
|
352
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
353
374
|
|
354
375
|
### Return type
|
355
376
|
|
@@ -357,7 +378,7 @@ Name | Type | Description | Notes
|
|
357
378
|
|
358
379
|
### Authorization
|
359
380
|
|
360
|
-
|
381
|
+
[api_key](../README.md#api_key)
|
361
382
|
|
362
383
|
### HTTP request headers
|
363
384
|
|
@@ -367,7 +388,7 @@ No authorization required
|
|
367
388
|
|
368
389
|
|
369
390
|
# **procedures_id_put**
|
370
|
-
> ProcedureOutput procedures_id_put(
|
391
|
+
> ProcedureOutput procedures_id_put(idbody)
|
371
392
|
|
372
393
|
Update a Procedure
|
373
394
|
|
@@ -375,21 +396,24 @@ Update a Procedure
|
|
375
396
|
```ruby
|
376
397
|
# load the gem
|
377
398
|
require 'yousign_client'
|
399
|
+
# setup authorization
|
400
|
+
YousignClient.configure do |config|
|
401
|
+
# Configure API key authorization: api_key
|
402
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
403
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
404
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
405
|
+
end
|
378
406
|
|
379
407
|
api_instance = YousignClient::ProceduresApi.new
|
380
408
|
|
381
409
|
id = 'id_example' # String |
|
382
410
|
|
383
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
384
|
-
|
385
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
386
|
-
|
387
411
|
body = YousignClient::ProcedureInput.new # ProcedureInput |
|
388
412
|
|
389
413
|
|
390
414
|
begin
|
391
415
|
#Update a Procedure
|
392
|
-
result = api_instance.procedures_id_put(
|
416
|
+
result = api_instance.procedures_id_put(idbody)
|
393
417
|
p result
|
394
418
|
rescue YousignClient::ApiError => e
|
395
419
|
puts "Exception when calling ProceduresApi->procedures_id_put: #{e}"
|
@@ -401,8 +425,6 @@ end
|
|
401
425
|
Name | Type | Description | Notes
|
402
426
|
------------- | ------------- | ------------- | -------------
|
403
427
|
**id** | **String**| |
|
404
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
405
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
406
428
|
**body** | [**ProcedureInput**](ProcedureInput.md)| |
|
407
429
|
|
408
430
|
### Return type
|
@@ -411,7 +433,7 @@ Name | Type | Description | Notes
|
|
411
433
|
|
412
434
|
### Authorization
|
413
435
|
|
414
|
-
|
436
|
+
[api_key](../README.md#api_key)
|
415
437
|
|
416
438
|
### HTTP request headers
|
417
439
|
|
@@ -421,7 +443,7 @@ No authorization required
|
|
421
443
|
|
422
444
|
|
423
445
|
# **procedures_id_remind_post**
|
424
|
-
> ProcedureOutput procedures_id_remind_post(id,
|
446
|
+
> ProcedureOutput procedures_id_remind_post(id, body)
|
425
447
|
|
426
448
|
Remind a Procedure
|
427
449
|
|
@@ -429,21 +451,24 @@ Remind a Procedure
|
|
429
451
|
```ruby
|
430
452
|
# load the gem
|
431
453
|
require 'yousign_client'
|
454
|
+
# setup authorization
|
455
|
+
YousignClient.configure do |config|
|
456
|
+
# Configure API key authorization: api_key
|
457
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
458
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
459
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
460
|
+
end
|
432
461
|
|
433
462
|
api_instance = YousignClient::ProceduresApi.new
|
434
463
|
|
435
464
|
id = 'id_example' # String |
|
436
465
|
|
437
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
438
|
-
|
439
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
440
|
-
|
441
466
|
body = YousignClient::ProcedureRemindInput.new # ProcedureRemindInput |
|
442
467
|
|
443
468
|
|
444
469
|
begin
|
445
470
|
#Remind a Procedure
|
446
|
-
result = api_instance.procedures_id_remind_post(id,
|
471
|
+
result = api_instance.procedures_id_remind_post(id, body)
|
447
472
|
p result
|
448
473
|
rescue YousignClient::ApiError => e
|
449
474
|
puts "Exception when calling ProceduresApi->procedures_id_remind_post: #{e}"
|
@@ -455,8 +480,6 @@ end
|
|
455
480
|
Name | Type | Description | Notes
|
456
481
|
------------- | ------------- | ------------- | -------------
|
457
482
|
**id** | **String**| |
|
458
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
459
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
460
483
|
**body** | [**ProcedureRemindInput**](ProcedureRemindInput.md)| |
|
461
484
|
|
462
485
|
### Return type
|
@@ -465,7 +488,7 @@ Name | Type | Description | Notes
|
|
465
488
|
|
466
489
|
### Authorization
|
467
490
|
|
468
|
-
|
491
|
+
[api_key](../README.md#api_key)
|
469
492
|
|
470
493
|
### HTTP request headers
|
471
494
|
|
@@ -475,7 +498,7 @@ No authorization required
|
|
475
498
|
|
476
499
|
|
477
500
|
# **procedures_post**
|
478
|
-
> ProcedureOutput procedures_post(
|
501
|
+
> ProcedureOutput procedures_post(body)
|
479
502
|
|
480
503
|
Create a new Procedure
|
481
504
|
|
@@ -483,19 +506,22 @@ Create a new Procedure
|
|
483
506
|
```ruby
|
484
507
|
# load the gem
|
485
508
|
require 'yousign_client'
|
509
|
+
# setup authorization
|
510
|
+
YousignClient.configure do |config|
|
511
|
+
# Configure API key authorization: api_key
|
512
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
513
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
514
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
515
|
+
end
|
486
516
|
|
487
517
|
api_instance = YousignClient::ProceduresApi.new
|
488
518
|
|
489
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
490
|
-
|
491
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
492
|
-
|
493
519
|
body = YousignClient::ProcedureInput.new # ProcedureInput |
|
494
520
|
|
495
521
|
|
496
522
|
begin
|
497
523
|
#Create a new Procedure
|
498
|
-
result = api_instance.procedures_post(
|
524
|
+
result = api_instance.procedures_post(body)
|
499
525
|
p result
|
500
526
|
rescue YousignClient::ApiError => e
|
501
527
|
puts "Exception when calling ProceduresApi->procedures_post: #{e}"
|
@@ -506,8 +532,6 @@ end
|
|
506
532
|
|
507
533
|
Name | Type | Description | Notes
|
508
534
|
------------- | ------------- | ------------- | -------------
|
509
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
510
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
511
535
|
**body** | [**ProcedureInput**](ProcedureInput.md)| |
|
512
536
|
|
513
537
|
### Return type
|
@@ -516,7 +540,7 @@ Name | Type | Description | Notes
|
|
516
540
|
|
517
541
|
### Authorization
|
518
542
|
|
519
|
-
|
543
|
+
[api_key](../README.md#api_key)
|
520
544
|
|
521
545
|
### HTTP request headers
|
522
546
|
|