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
data/docs/ServerStampsApi.md
CHANGED
@@ -9,7 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
|
10
10
|
|
11
11
|
# **server_stamps_id_get**
|
12
|
-
> ServerStampOutput server_stamps_id_get(id
|
12
|
+
> ServerStampOutput server_stamps_id_get(id)
|
13
13
|
|
14
14
|
Find a Server Stamp by ID
|
15
15
|
|
@@ -17,17 +17,22 @@ Find a Server Stamp 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::ServerStampsApi.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 a Server Stamp by ID
|
30
|
-
result = api_instance.server_stamps_id_get(id
|
35
|
+
result = api_instance.server_stamps_id_get(id)
|
31
36
|
p result
|
32
37
|
rescue YousignClient::ApiError => e
|
33
38
|
puts "Exception when calling ServerStampsApi->server_stamps_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
|
# **server_stamps_post**
|
60
|
-
> ServerStampOutput server_stamps_post(
|
64
|
+
> ServerStampOutput server_stamps_post(body)
|
61
65
|
|
62
66
|
Create a Server Stamp
|
63
67
|
|
@@ -65,19 +69,22 @@ Create a Server Stamp
|
|
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::ServerStampsApi.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::ServerStampInput.new # ServerStampInput |
|
76
83
|
|
77
84
|
|
78
85
|
begin
|
79
86
|
#Create a Server Stamp
|
80
|
-
result = api_instance.server_stamps_post(
|
87
|
+
result = api_instance.server_stamps_post(body)
|
81
88
|
p result
|
82
89
|
rescue YousignClient::ApiError => e
|
83
90
|
puts "Exception when calling ServerStampsApi->server_stamps_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** | [**ServerStampInput**](ServerStampInput.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/SignatureUIsApi.md
CHANGED
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
17
17
|
|
18
18
|
|
19
19
|
# **signature_ui_labels_get**
|
20
|
-
> Array<SignatureUiLabelOutput> signature_ui_labels_get(
|
20
|
+
> Array<SignatureUiLabelOutput> signature_ui_labels_get(opts)
|
21
21
|
|
22
22
|
Get Signature UI Labels
|
23
23
|
|
@@ -27,11 +27,16 @@ Only usefull if you use a filter with name or signatureUI
|
|
27
27
|
```ruby
|
28
28
|
# load the gem
|
29
29
|
require 'yousign_client'
|
30
|
+
# setup authorization
|
31
|
+
YousignClient.configure do |config|
|
32
|
+
# Configure API key authorization: api_key
|
33
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
34
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
35
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
36
|
+
end
|
30
37
|
|
31
38
|
api_instance = YousignClient::SignatureUIsApi.new
|
32
39
|
|
33
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
34
|
-
|
35
40
|
opts = {
|
36
41
|
name: 'name_example', # String | Filtering on name of signature ui labels
|
37
42
|
signature_ui: 'signature_ui_example' # String | Filtering on id of signature ui resource
|
@@ -39,7 +44,7 @@ opts = {
|
|
39
44
|
|
40
45
|
begin
|
41
46
|
#Get Signature UI Labels
|
42
|
-
result = api_instance.signature_ui_labels_get(
|
47
|
+
result = api_instance.signature_ui_labels_get(opts)
|
43
48
|
p result
|
44
49
|
rescue YousignClient::ApiError => e
|
45
50
|
puts "Exception when calling SignatureUIsApi->signature_ui_labels_get: #{e}"
|
@@ -50,7 +55,6 @@ end
|
|
50
55
|
|
51
56
|
Name | Type | Description | Notes
|
52
57
|
------------- | ------------- | ------------- | -------------
|
53
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
54
58
|
**name** | **String**| Filtering on name of signature ui labels | [optional]
|
55
59
|
**signature_ui** | **String**| Filtering on id of signature ui resource | [optional]
|
56
60
|
|
@@ -60,7 +64,7 @@ Name | Type | Description | Notes
|
|
60
64
|
|
61
65
|
### Authorization
|
62
66
|
|
63
|
-
|
67
|
+
[api_key](../README.md#api_key)
|
64
68
|
|
65
69
|
### HTTP request headers
|
66
70
|
|
@@ -70,7 +74,7 @@ No authorization required
|
|
70
74
|
|
71
75
|
|
72
76
|
# **signature_ui_labels_id_delete**
|
73
|
-
> signature_ui_labels_id_delete(id,
|
77
|
+
> signature_ui_labels_id_delete(id, opts)
|
74
78
|
|
75
79
|
Delete a Signature UI Label
|
76
80
|
|
@@ -78,20 +82,25 @@ Delete a Signature UI Label
|
|
78
82
|
```ruby
|
79
83
|
# load the gem
|
80
84
|
require 'yousign_client'
|
85
|
+
# setup authorization
|
86
|
+
YousignClient.configure do |config|
|
87
|
+
# Configure API key authorization: api_key
|
88
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
89
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
90
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
91
|
+
end
|
81
92
|
|
82
93
|
api_instance = YousignClient::SignatureUIsApi.new
|
83
94
|
|
84
95
|
id = 'id_example' # String |
|
85
96
|
|
86
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
87
|
-
|
88
97
|
opts = {
|
89
98
|
id2: '/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | Id of signature ui label
|
90
99
|
}
|
91
100
|
|
92
101
|
begin
|
93
102
|
#Delete a Signature UI Label
|
94
|
-
api_instance.signature_ui_labels_id_delete(id,
|
103
|
+
api_instance.signature_ui_labels_id_delete(id, opts)
|
95
104
|
rescue YousignClient::ApiError => e
|
96
105
|
puts "Exception when calling SignatureUIsApi->signature_ui_labels_id_delete: #{e}"
|
97
106
|
end
|
@@ -102,7 +111,6 @@ end
|
|
102
111
|
Name | Type | Description | Notes
|
103
112
|
------------- | ------------- | ------------- | -------------
|
104
113
|
**id** | **String**| |
|
105
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
106
114
|
**id2** | **String**| Id of signature ui label | [optional]
|
107
115
|
|
108
116
|
### Return type
|
@@ -111,7 +119,7 @@ nil (empty response body)
|
|
111
119
|
|
112
120
|
### Authorization
|
113
121
|
|
114
|
-
|
122
|
+
[api_key](../README.md#api_key)
|
115
123
|
|
116
124
|
### HTTP request headers
|
117
125
|
|
@@ -121,7 +129,7 @@ No authorization required
|
|
121
129
|
|
122
130
|
|
123
131
|
# **signature_ui_labels_id_get**
|
124
|
-
> SignatureUiLabelOutput signature_ui_labels_id_get(id,
|
132
|
+
> SignatureUiLabelOutput signature_ui_labels_id_get(id, opts)
|
125
133
|
|
126
134
|
Find a Signature UI Label by ID
|
127
135
|
|
@@ -129,20 +137,25 @@ Find a Signature UI Label by ID
|
|
129
137
|
```ruby
|
130
138
|
# load the gem
|
131
139
|
require 'yousign_client'
|
140
|
+
# setup authorization
|
141
|
+
YousignClient.configure do |config|
|
142
|
+
# Configure API key authorization: api_key
|
143
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
144
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
145
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
146
|
+
end
|
132
147
|
|
133
148
|
api_instance = YousignClient::SignatureUIsApi.new
|
134
149
|
|
135
150
|
id = 'id_example' # String |
|
136
151
|
|
137
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
138
|
-
|
139
152
|
opts = {
|
140
153
|
id2: '/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | id of signature ui label
|
141
154
|
}
|
142
155
|
|
143
156
|
begin
|
144
157
|
#Find a Signature UI Label by ID
|
145
|
-
result = api_instance.signature_ui_labels_id_get(id,
|
158
|
+
result = api_instance.signature_ui_labels_id_get(id, opts)
|
146
159
|
p result
|
147
160
|
rescue YousignClient::ApiError => e
|
148
161
|
puts "Exception when calling SignatureUIsApi->signature_ui_labels_id_get: #{e}"
|
@@ -154,7 +167,6 @@ end
|
|
154
167
|
Name | Type | Description | Notes
|
155
168
|
------------- | ------------- | ------------- | -------------
|
156
169
|
**id** | **String**| |
|
157
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
158
170
|
**id2** | **String**| id of signature ui label | [optional]
|
159
171
|
|
160
172
|
### Return type
|
@@ -163,7 +175,7 @@ Name | Type | Description | Notes
|
|
163
175
|
|
164
176
|
### Authorization
|
165
177
|
|
166
|
-
|
178
|
+
[api_key](../README.md#api_key)
|
167
179
|
|
168
180
|
### HTTP request headers
|
169
181
|
|
@@ -173,7 +185,7 @@ No authorization required
|
|
173
185
|
|
174
186
|
|
175
187
|
# **signature_ui_labels_id_put**
|
176
|
-
> SignatureUiLabelOutput signature_ui_labels_id_put(
|
188
|
+
> SignatureUiLabelOutput signature_ui_labels_id_put(idbody, opts)
|
177
189
|
|
178
190
|
Update a Signature UI Label
|
179
191
|
|
@@ -181,15 +193,18 @@ Update a Signature UI Label
|
|
181
193
|
```ruby
|
182
194
|
# load the gem
|
183
195
|
require 'yousign_client'
|
196
|
+
# setup authorization
|
197
|
+
YousignClient.configure do |config|
|
198
|
+
# Configure API key authorization: api_key
|
199
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
200
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
201
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
202
|
+
end
|
184
203
|
|
185
204
|
api_instance = YousignClient::SignatureUIsApi.new
|
186
205
|
|
187
206
|
id = 'id_example' # String |
|
188
207
|
|
189
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
190
|
-
|
191
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
192
|
-
|
193
208
|
body = YousignClient::SignatureUiLabelInput.new # SignatureUiLabelInput |
|
194
209
|
|
195
210
|
opts = {
|
@@ -198,7 +213,7 @@ opts = {
|
|
198
213
|
|
199
214
|
begin
|
200
215
|
#Update a Signature UI Label
|
201
|
-
result = api_instance.signature_ui_labels_id_put(
|
216
|
+
result = api_instance.signature_ui_labels_id_put(idbody, opts)
|
202
217
|
p result
|
203
218
|
rescue YousignClient::ApiError => e
|
204
219
|
puts "Exception when calling SignatureUIsApi->signature_ui_labels_id_put: #{e}"
|
@@ -210,8 +225,6 @@ end
|
|
210
225
|
Name | Type | Description | Notes
|
211
226
|
------------- | ------------- | ------------- | -------------
|
212
227
|
**id** | **String**| |
|
213
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
214
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
215
228
|
**body** | [**SignatureUiLabelInput**](SignatureUiLabelInput.md)| |
|
216
229
|
**id2** | **String**| Id of signature ui labels | [optional]
|
217
230
|
|
@@ -221,7 +234,7 @@ Name | Type | Description | Notes
|
|
221
234
|
|
222
235
|
### Authorization
|
223
236
|
|
224
|
-
|
237
|
+
[api_key](../README.md#api_key)
|
225
238
|
|
226
239
|
### HTTP request headers
|
227
240
|
|
@@ -231,7 +244,7 @@ No authorization required
|
|
231
244
|
|
232
245
|
|
233
246
|
# **signature_ui_labels_post**
|
234
|
-
> SignatureUiLabelOutput signature_ui_labels_post(
|
247
|
+
> SignatureUiLabelOutput signature_ui_labels_post(body)
|
235
248
|
|
236
249
|
Create a new Signature UI Label
|
237
250
|
|
@@ -239,19 +252,22 @@ Create a new Signature UI Label
|
|
239
252
|
```ruby
|
240
253
|
# load the gem
|
241
254
|
require 'yousign_client'
|
255
|
+
# setup authorization
|
256
|
+
YousignClient.configure do |config|
|
257
|
+
# Configure API key authorization: api_key
|
258
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
259
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
260
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
261
|
+
end
|
242
262
|
|
243
263
|
api_instance = YousignClient::SignatureUIsApi.new
|
244
264
|
|
245
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
246
|
-
|
247
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
248
|
-
|
249
265
|
body = YousignClient::SignatureUiLabelInput.new # SignatureUiLabelInput |
|
250
266
|
|
251
267
|
|
252
268
|
begin
|
253
269
|
#Create a new Signature UI Label
|
254
|
-
result = api_instance.signature_ui_labels_post(
|
270
|
+
result = api_instance.signature_ui_labels_post(body)
|
255
271
|
p result
|
256
272
|
rescue YousignClient::ApiError => e
|
257
273
|
puts "Exception when calling SignatureUIsApi->signature_ui_labels_post: #{e}"
|
@@ -262,8 +278,6 @@ end
|
|
262
278
|
|
263
279
|
Name | Type | Description | Notes
|
264
280
|
------------- | ------------- | ------------- | -------------
|
265
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
266
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
267
281
|
**body** | [**SignatureUiLabelInput**](SignatureUiLabelInput.md)| |
|
268
282
|
|
269
283
|
### Return type
|
@@ -272,7 +286,7 @@ Name | Type | Description | Notes
|
|
272
286
|
|
273
287
|
### Authorization
|
274
288
|
|
275
|
-
|
289
|
+
[api_key](../README.md#api_key)
|
276
290
|
|
277
291
|
### HTTP request headers
|
278
292
|
|
@@ -282,7 +296,7 @@ No authorization required
|
|
282
296
|
|
283
297
|
|
284
298
|
# **signature_uis_get**
|
285
|
-
> Array<SignatureUiOutput> signature_uis_get
|
299
|
+
> Array<SignatureUiOutput> signature_uis_get
|
286
300
|
|
287
301
|
Get Signature UI list
|
288
302
|
|
@@ -290,15 +304,19 @@ Get Signature UI list
|
|
290
304
|
```ruby
|
291
305
|
# load the gem
|
292
306
|
require 'yousign_client'
|
307
|
+
# setup authorization
|
308
|
+
YousignClient.configure do |config|
|
309
|
+
# Configure API key authorization: api_key
|
310
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
311
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
312
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
313
|
+
end
|
293
314
|
|
294
315
|
api_instance = YousignClient::SignatureUIsApi.new
|
295
316
|
|
296
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
297
|
-
|
298
|
-
|
299
317
|
begin
|
300
318
|
#Get Signature UI list
|
301
|
-
result = api_instance.signature_uis_get
|
319
|
+
result = api_instance.signature_uis_get
|
302
320
|
p result
|
303
321
|
rescue YousignClient::ApiError => e
|
304
322
|
puts "Exception when calling SignatureUIsApi->signature_uis_get: #{e}"
|
@@ -306,10 +324,7 @@ end
|
|
306
324
|
```
|
307
325
|
|
308
326
|
### Parameters
|
309
|
-
|
310
|
-
Name | Type | Description | Notes
|
311
|
-
------------- | ------------- | ------------- | -------------
|
312
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
327
|
+
This endpoint does not need any parameter.
|
313
328
|
|
314
329
|
### Return type
|
315
330
|
|
@@ -317,7 +332,7 @@ Name | Type | Description | Notes
|
|
317
332
|
|
318
333
|
### Authorization
|
319
334
|
|
320
|
-
|
335
|
+
[api_key](../README.md#api_key)
|
321
336
|
|
322
337
|
### HTTP request headers
|
323
338
|
|
@@ -327,7 +342,7 @@ No authorization required
|
|
327
342
|
|
328
343
|
|
329
344
|
# **signature_uis_id_delete**
|
330
|
-
> signature_uis_id_delete(id,
|
345
|
+
> signature_uis_id_delete(id, opts)
|
331
346
|
|
332
347
|
Delete a Signature UI
|
333
348
|
|
@@ -335,22 +350,25 @@ Delete a Signature UI
|
|
335
350
|
```ruby
|
336
351
|
# load the gem
|
337
352
|
require 'yousign_client'
|
353
|
+
# setup authorization
|
354
|
+
YousignClient.configure do |config|
|
355
|
+
# Configure API key authorization: api_key
|
356
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
357
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
358
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
359
|
+
end
|
338
360
|
|
339
361
|
api_instance = YousignClient::SignatureUIsApi.new
|
340
362
|
|
341
363
|
id = 'id_example' # String |
|
342
364
|
|
343
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
344
|
-
|
345
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
346
|
-
|
347
365
|
opts = {
|
348
366
|
id2: '/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | Id of the signature ui
|
349
367
|
}
|
350
368
|
|
351
369
|
begin
|
352
370
|
#Delete a Signature UI
|
353
|
-
api_instance.signature_uis_id_delete(id,
|
371
|
+
api_instance.signature_uis_id_delete(id, opts)
|
354
372
|
rescue YousignClient::ApiError => e
|
355
373
|
puts "Exception when calling SignatureUIsApi->signature_uis_id_delete: #{e}"
|
356
374
|
end
|
@@ -361,8 +379,6 @@ end
|
|
361
379
|
Name | Type | Description | Notes
|
362
380
|
------------- | ------------- | ------------- | -------------
|
363
381
|
**id** | **String**| |
|
364
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
365
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
366
382
|
**id2** | **String**| Id of the signature ui | [optional]
|
367
383
|
|
368
384
|
### Return type
|
@@ -371,7 +387,7 @@ nil (empty response body)
|
|
371
387
|
|
372
388
|
### Authorization
|
373
389
|
|
374
|
-
|
390
|
+
[api_key](../README.md#api_key)
|
375
391
|
|
376
392
|
### HTTP request headers
|
377
393
|
|
@@ -381,7 +397,7 @@ No authorization required
|
|
381
397
|
|
382
398
|
|
383
399
|
# **signature_uis_id_get**
|
384
|
-
> SignatureUiOutput signature_uis_id_get(id,
|
400
|
+
> SignatureUiOutput signature_uis_id_get(id, opts)
|
385
401
|
|
386
402
|
Find a Signature UI by ID
|
387
403
|
|
@@ -389,22 +405,25 @@ Find a Signature UI by ID
|
|
389
405
|
```ruby
|
390
406
|
# load the gem
|
391
407
|
require 'yousign_client'
|
408
|
+
# setup authorization
|
409
|
+
YousignClient.configure do |config|
|
410
|
+
# Configure API key authorization: api_key
|
411
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
412
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
413
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
414
|
+
end
|
392
415
|
|
393
416
|
api_instance = YousignClient::SignatureUIsApi.new
|
394
417
|
|
395
418
|
id = 'id_example' # String |
|
396
419
|
|
397
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
398
|
-
|
399
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
400
|
-
|
401
420
|
opts = {
|
402
421
|
id2: '/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | id of a signature ui
|
403
422
|
}
|
404
423
|
|
405
424
|
begin
|
406
425
|
#Find a Signature UI by ID
|
407
|
-
result = api_instance.signature_uis_id_get(id,
|
426
|
+
result = api_instance.signature_uis_id_get(id, opts)
|
408
427
|
p result
|
409
428
|
rescue YousignClient::ApiError => e
|
410
429
|
puts "Exception when calling SignatureUIsApi->signature_uis_id_get: #{e}"
|
@@ -416,8 +435,6 @@ end
|
|
416
435
|
Name | Type | Description | Notes
|
417
436
|
------------- | ------------- | ------------- | -------------
|
418
437
|
**id** | **String**| |
|
419
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
420
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
421
438
|
**id2** | **String**| id of a signature ui | [optional]
|
422
439
|
|
423
440
|
### Return type
|
@@ -426,7 +443,7 @@ Name | Type | Description | Notes
|
|
426
443
|
|
427
444
|
### Authorization
|
428
445
|
|
429
|
-
|
446
|
+
[api_key](../README.md#api_key)
|
430
447
|
|
431
448
|
### HTTP request headers
|
432
449
|
|
@@ -436,7 +453,7 @@ No authorization required
|
|
436
453
|
|
437
454
|
|
438
455
|
# **signature_uis_id_put**
|
439
|
-
> SignatureUiInputUpdate signature_uis_id_put(id,
|
456
|
+
> SignatureUiInputUpdate signature_uis_id_put(id, opts)
|
440
457
|
|
441
458
|
Update a Signature UI
|
442
459
|
|
@@ -444,22 +461,25 @@ Update a Signature UI
|
|
444
461
|
```ruby
|
445
462
|
# load the gem
|
446
463
|
require 'yousign_client'
|
464
|
+
# setup authorization
|
465
|
+
YousignClient.configure do |config|
|
466
|
+
# Configure API key authorization: api_key
|
467
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
468
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
469
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
470
|
+
end
|
447
471
|
|
448
472
|
api_instance = YousignClient::SignatureUIsApi.new
|
449
473
|
|
450
474
|
id = 'id_example' # String |
|
451
475
|
|
452
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
453
|
-
|
454
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
455
|
-
|
456
476
|
opts = {
|
457
477
|
id2: '/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | id of signature ui to update
|
458
478
|
}
|
459
479
|
|
460
480
|
begin
|
461
481
|
#Update a Signature UI
|
462
|
-
result = api_instance.signature_uis_id_put(id,
|
482
|
+
result = api_instance.signature_uis_id_put(id, opts)
|
463
483
|
p result
|
464
484
|
rescue YousignClient::ApiError => e
|
465
485
|
puts "Exception when calling SignatureUIsApi->signature_uis_id_put: #{e}"
|
@@ -471,8 +491,6 @@ end
|
|
471
491
|
Name | Type | Description | Notes
|
472
492
|
------------- | ------------- | ------------- | -------------
|
473
493
|
**id** | **String**| |
|
474
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
475
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
476
494
|
**id2** | **String**| id of signature ui to update | [optional]
|
477
495
|
|
478
496
|
### Return type
|
@@ -481,7 +499,7 @@ Name | Type | Description | Notes
|
|
481
499
|
|
482
500
|
### Authorization
|
483
501
|
|
484
|
-
|
502
|
+
[api_key](../README.md#api_key)
|
485
503
|
|
486
504
|
### HTTP request headers
|
487
505
|
|
@@ -491,7 +509,7 @@ No authorization required
|
|
491
509
|
|
492
510
|
|
493
511
|
# **signature_uis_post**
|
494
|
-
> SignatureUiOutput signature_uis_post(
|
512
|
+
> SignatureUiOutput signature_uis_post(body)
|
495
513
|
|
496
514
|
Create a new Signature UI
|
497
515
|
|
@@ -501,19 +519,22 @@ Here is the url format to build on your side to get a custom signature interface
|
|
501
519
|
```ruby
|
502
520
|
# load the gem
|
503
521
|
require 'yousign_client'
|
522
|
+
# setup authorization
|
523
|
+
YousignClient.configure do |config|
|
524
|
+
# Configure API key authorization: api_key
|
525
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
526
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
527
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
528
|
+
end
|
504
529
|
|
505
530
|
api_instance = YousignClient::SignatureUIsApi.new
|
506
531
|
|
507
|
-
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
508
|
-
|
509
|
-
content_type = 'application/json' # String | The MIME type of the body of the request
|
510
|
-
|
511
532
|
body = YousignClient::SignatureUiInput.new # SignatureUiInput |
|
512
533
|
|
513
534
|
|
514
535
|
begin
|
515
536
|
#Create a new Signature UI
|
516
|
-
result = api_instance.signature_uis_post(
|
537
|
+
result = api_instance.signature_uis_post(body)
|
517
538
|
p result
|
518
539
|
rescue YousignClient::ApiError => e
|
519
540
|
puts "Exception when calling SignatureUIsApi->signature_uis_post: #{e}"
|
@@ -524,8 +545,6 @@ end
|
|
524
545
|
|
525
546
|
Name | Type | Description | Notes
|
526
547
|
------------- | ------------- | ------------- | -------------
|
527
|
-
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
528
|
-
**content_type** | **String**| The MIME type of the body of the request |
|
529
548
|
**body** | [**SignatureUiInput**](SignatureUiInput.md)| |
|
530
549
|
|
531
550
|
### Return type
|
@@ -534,7 +553,7 @@ Name | Type | Description | Notes
|
|
534
553
|
|
535
554
|
### Authorization
|
536
555
|
|
537
|
-
|
556
|
+
[api_key](../README.md#api_key)
|
538
557
|
|
539
558
|
### HTTP request headers
|
540
559
|
|