signrequest_client 0.1.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +43 -44
- data/docs/ApiTokensApi.md +13 -9
- data/docs/Document.md +16 -19
- data/docs/DocumentAttachment.md +5 -5
- data/docs/DocumentAttachmentsApi.md +9 -6
- data/docs/DocumentSearch.md +5 -5
- data/docs/DocumentsApi.md +12 -65
- data/docs/DocumentsSearchApi.md +23 -58
- data/docs/Event.md +0 -1
- data/docs/EventsApi.md +6 -4
- data/docs/InlineResponse201.md +9 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/InlineSignRequest.md +15 -15
- data/docs/SignRequest.md +15 -15
- data/docs/SignRequestQuickCreate.md +25 -25
- data/docs/SignerAttachment.md +1 -1
- data/docs/SigningLog.md +2 -2
- data/docs/SignrequestQuickCreateApi.md +3 -2
- data/docs/SignrequestsApi.md +21 -22
- data/docs/TeamMember.md +0 -1
- data/docs/TeamMembersApi.md +6 -4
- data/docs/TeamsApi.md +20 -72
- data/docs/Template.md +2 -3
- data/docs/TemplatesApi.md +6 -4
- data/docs/WebhookSubscription.md +1 -2
- data/docs/WebhooksApi.md +18 -12
- data/lib/signrequest_client.rb +2 -0
- data/lib/signrequest_client/api/api_tokens_api.rb +10 -10
- data/lib/signrequest_client/api/document_attachments_api.rb +6 -6
- data/lib/signrequest_client/api/documents_api.rb +8 -69
- data/lib/signrequest_client/api/documents_search_api.rb +31 -59
- data/lib/signrequest_client/api/events_api.rb +4 -4
- data/lib/signrequest_client/api/signrequest_quick_create_api.rb +2 -2
- data/lib/signrequest_client/api/signrequests_api.rb +24 -36
- data/lib/signrequest_client/api/team_members_api.rb +4 -4
- data/lib/signrequest_client/api/teams_api.rb +20 -81
- data/lib/signrequest_client/api/templates_api.rb +4 -4
- data/lib/signrequest_client/api/webhooks_api.rb +12 -12
- data/lib/signrequest_client/models/document.rb +19 -30
- data/lib/signrequest_client/models/document_attachment.rb +5 -0
- data/lib/signrequest_client/models/document_search.rb +60 -79
- data/lib/signrequest_client/models/event.rb +3 -12
- data/lib/signrequest_client/models/inline_prefill_tags.rb +1 -1
- data/lib/signrequest_client/models/inline_response_201.rb +240 -0
- data/lib/signrequest_client/models/inline_response_201_1.rb +226 -0
- data/lib/signrequest_client/models/inline_sign_request.rb +46 -38
- data/lib/signrequest_client/models/sign_request.rb +15 -0
- data/lib/signrequest_client/models/sign_request_quick_create.rb +25 -0
- data/lib/signrequest_client/models/signer_attachment.rb +1 -0
- data/lib/signrequest_client/models/signing_log.rb +7 -5
- data/lib/signrequest_client/models/team_member.rb +1 -10
- data/lib/signrequest_client/models/template.rb +3 -10
- data/lib/signrequest_client/models/webhook_subscription.rb +4 -12
- data/lib/signrequest_client/version.rb +1 -1
- data/pkg/signrequest_client-0.1.0.gem +0 -0
- data/spec/models/inline_response_201_1_spec.rb +46 -0
- data/spec/models/inline_response_201_spec.rb +52 -0
- metadata +11 -3
@@ -20,7 +20,7 @@ module SignRequestClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
|
23
|
-
#
|
23
|
+
# Retrieve a list of Team Members
|
24
24
|
#
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [String] :is_active
|
@@ -37,7 +37,7 @@ module SignRequestClient
|
|
37
37
|
return data
|
38
38
|
end
|
39
39
|
|
40
|
-
#
|
40
|
+
# Retrieve a list of Team Members
|
41
41
|
#
|
42
42
|
# @param [Hash] opts the optional parameters
|
43
43
|
# @option opts [String] :is_active
|
@@ -93,7 +93,7 @@ module SignRequestClient
|
|
93
93
|
return data, status_code, headers
|
94
94
|
end
|
95
95
|
|
96
|
-
#
|
96
|
+
# Retrieve a Team Member
|
97
97
|
#
|
98
98
|
# @param uuid
|
99
99
|
# @param [Hash] opts the optional parameters
|
@@ -103,7 +103,7 @@ module SignRequestClient
|
|
103
103
|
return data
|
104
104
|
end
|
105
105
|
|
106
|
-
#
|
106
|
+
# Retrieve a Team Member
|
107
107
|
#
|
108
108
|
# @param uuid
|
109
109
|
# @param [Hash] opts the optional parameters
|
@@ -20,8 +20,8 @@ module SignRequestClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
|
23
|
-
#
|
24
|
-
#
|
23
|
+
# Create a Team
|
24
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
25
25
|
# @param data
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [Team]
|
@@ -30,8 +30,8 @@ module SignRequestClient
|
|
30
30
|
return data
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
34
|
-
#
|
33
|
+
# Create a Team
|
34
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
35
35
|
# @param data
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
37
|
# @return [Array<(Team, Fixnum, Hash)>] Team data, response status code and response headers
|
@@ -75,8 +75,8 @@ module SignRequestClient
|
|
75
75
|
return data, status_code, headers
|
76
76
|
end
|
77
77
|
|
78
|
-
#
|
79
|
-
#
|
78
|
+
# Invite a Team Member
|
79
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
80
80
|
# @param subdomain
|
81
81
|
# @param data
|
82
82
|
# @param [Hash] opts the optional parameters
|
@@ -86,8 +86,8 @@ module SignRequestClient
|
|
86
86
|
return data
|
87
87
|
end
|
88
88
|
|
89
|
-
#
|
90
|
-
#
|
89
|
+
# Invite a Team Member
|
90
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
91
91
|
# @param subdomain
|
92
92
|
# @param data
|
93
93
|
# @param [Hash] opts the optional parameters
|
@@ -136,8 +136,8 @@ module SignRequestClient
|
|
136
136
|
return data, status_code, headers
|
137
137
|
end
|
138
138
|
|
139
|
-
#
|
140
|
-
#
|
139
|
+
# Retrieve a list of Teams
|
140
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
141
141
|
# @param [Hash] opts the optional parameters
|
142
142
|
# @option opts [Integer] :page A page number within the paginated result set.
|
143
143
|
# @option opts [Integer] :limit Number of results to return per page.
|
@@ -147,8 +147,8 @@ module SignRequestClient
|
|
147
147
|
return data
|
148
148
|
end
|
149
149
|
|
150
|
-
#
|
151
|
-
#
|
150
|
+
# Retrieve a list of Teams
|
151
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
152
152
|
# @param [Hash] opts the optional parameters
|
153
153
|
# @option opts [Integer] :page A page number within the paginated result set.
|
154
154
|
# @option opts [Integer] :limit Number of results to return per page.
|
@@ -191,8 +191,8 @@ module SignRequestClient
|
|
191
191
|
return data, status_code, headers
|
192
192
|
end
|
193
193
|
|
194
|
-
#
|
195
|
-
#
|
194
|
+
# Update a Team
|
195
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
196
196
|
# @param subdomain
|
197
197
|
# @param data
|
198
198
|
# @param [Hash] opts the optional parameters
|
@@ -202,8 +202,8 @@ module SignRequestClient
|
|
202
202
|
return data
|
203
203
|
end
|
204
204
|
|
205
|
-
#
|
206
|
-
#
|
205
|
+
# Update a Team
|
206
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
207
207
|
# @param subdomain
|
208
208
|
# @param data
|
209
209
|
# @param [Hash] opts the optional parameters
|
@@ -252,8 +252,8 @@ module SignRequestClient
|
|
252
252
|
return data, status_code, headers
|
253
253
|
end
|
254
254
|
|
255
|
-
#
|
256
|
-
#
|
255
|
+
# Retrieve a Team
|
256
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
257
257
|
# @param subdomain
|
258
258
|
# @param [Hash] opts the optional parameters
|
259
259
|
# @return [Team]
|
@@ -262,8 +262,8 @@ module SignRequestClient
|
|
262
262
|
return data
|
263
263
|
end
|
264
264
|
|
265
|
-
#
|
266
|
-
#
|
265
|
+
# Retrieve a Team
|
266
|
+
# Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
267
267
|
# @param subdomain
|
268
268
|
# @param [Hash] opts the optional parameters
|
269
269
|
# @return [Array<(Team, Fixnum, Hash)>] Team data, response status code and response headers
|
@@ -306,66 +306,5 @@ module SignRequestClient
|
|
306
306
|
end
|
307
307
|
return data, status_code, headers
|
308
308
|
end
|
309
|
-
|
310
|
-
#
|
311
|
-
# If your application requires to create Teams and act on behalf of them you need to become an integration partner. Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
312
|
-
# @param subdomain
|
313
|
-
# @param data
|
314
|
-
# @param [Hash] opts the optional parameters
|
315
|
-
# @return [Team]
|
316
|
-
def teams_update(subdomain, data, opts = {})
|
317
|
-
data, _status_code, _headers = teams_update_with_http_info(subdomain, data, opts)
|
318
|
-
return data
|
319
|
-
end
|
320
|
-
|
321
|
-
#
|
322
|
-
# If your application requires to create Teams and act on behalf of them you need to become an integration partner. Required fields are **name** and **subdomain** where the subdomain is globally unique. Use **POST** to create a Team. To update a field on a Team use **PATCH**. To use the API on behalf of a particular team change the endpoint to: *https://**{{ subdomain }}**.signrequest.com/api/v1/...* To invite new team members you can use **POST** {\"email\":\"**email-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
|
323
|
-
# @param subdomain
|
324
|
-
# @param data
|
325
|
-
# @param [Hash] opts the optional parameters
|
326
|
-
# @return [Array<(Team, Fixnum, Hash)>] Team data, response status code and response headers
|
327
|
-
def teams_update_with_http_info(subdomain, data, opts = {})
|
328
|
-
if @api_client.config.debugging
|
329
|
-
@api_client.config.logger.debug "Calling API: TeamsApi.teams_update ..."
|
330
|
-
end
|
331
|
-
# verify the required parameter 'subdomain' is set
|
332
|
-
if @api_client.config.client_side_validation && subdomain.nil?
|
333
|
-
fail ArgumentError, "Missing the required parameter 'subdomain' when calling TeamsApi.teams_update"
|
334
|
-
end
|
335
|
-
# verify the required parameter 'data' is set
|
336
|
-
if @api_client.config.client_side_validation && data.nil?
|
337
|
-
fail ArgumentError, "Missing the required parameter 'data' when calling TeamsApi.teams_update"
|
338
|
-
end
|
339
|
-
# resource path
|
340
|
-
local_var_path = "/teams/{subdomain}/".sub('{' + 'subdomain' + '}', subdomain.to_s)
|
341
|
-
|
342
|
-
# query parameters
|
343
|
-
query_params = {}
|
344
|
-
|
345
|
-
# header parameters
|
346
|
-
header_params = {}
|
347
|
-
# HTTP header 'Accept' (if needed)
|
348
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
349
|
-
# HTTP header 'Content-Type'
|
350
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
351
|
-
|
352
|
-
# form parameters
|
353
|
-
form_params = {}
|
354
|
-
|
355
|
-
# http body (model)
|
356
|
-
post_body = @api_client.object_to_http_body(data)
|
357
|
-
auth_names = ['Token']
|
358
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
359
|
-
:header_params => header_params,
|
360
|
-
:query_params => query_params,
|
361
|
-
:form_params => form_params,
|
362
|
-
:body => post_body,
|
363
|
-
:auth_names => auth_names,
|
364
|
-
:return_type => 'Team')
|
365
|
-
if @api_client.config.debugging
|
366
|
-
@api_client.config.logger.debug "API called: TeamsApi#teams_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
367
|
-
end
|
368
|
-
return data, status_code, headers
|
369
|
-
end
|
370
309
|
end
|
371
310
|
end
|
@@ -20,7 +20,7 @@ module SignRequestClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
|
23
|
-
#
|
23
|
+
# Retrieve a list of Templates
|
24
24
|
#
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [Integer] :page A page number within the paginated result set.
|
@@ -31,7 +31,7 @@ module SignRequestClient
|
|
31
31
|
return data
|
32
32
|
end
|
33
33
|
|
34
|
-
#
|
34
|
+
# Retrieve a list of Templates
|
35
35
|
#
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
37
|
# @option opts [Integer] :page A page number within the paginated result set.
|
@@ -75,7 +75,7 @@ module SignRequestClient
|
|
75
75
|
return data, status_code, headers
|
76
76
|
end
|
77
77
|
|
78
|
-
#
|
78
|
+
# Retrieve a Template
|
79
79
|
#
|
80
80
|
# @param uuid
|
81
81
|
# @param [Hash] opts the optional parameters
|
@@ -85,7 +85,7 @@ module SignRequestClient
|
|
85
85
|
return data
|
86
86
|
end
|
87
87
|
|
88
|
-
#
|
88
|
+
# Retrieve a Template
|
89
89
|
#
|
90
90
|
# @param uuid
|
91
91
|
# @param [Hash] opts the optional parameters
|
@@ -20,7 +20,7 @@ module SignRequestClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
|
23
|
-
#
|
23
|
+
# Create a Webhook
|
24
24
|
#
|
25
25
|
# @param data
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -30,7 +30,7 @@ module SignRequestClient
|
|
30
30
|
return data
|
31
31
|
end
|
32
32
|
|
33
|
-
#
|
33
|
+
# Create a Webhook
|
34
34
|
#
|
35
35
|
# @param data
|
36
36
|
# @param [Hash] opts the optional parameters
|
@@ -75,7 +75,7 @@ module SignRequestClient
|
|
75
75
|
return data, status_code, headers
|
76
76
|
end
|
77
77
|
|
78
|
-
#
|
78
|
+
# Delete a Webhook
|
79
79
|
#
|
80
80
|
# @param uuid
|
81
81
|
# @param [Hash] opts the optional parameters
|
@@ -85,7 +85,7 @@ module SignRequestClient
|
|
85
85
|
return nil
|
86
86
|
end
|
87
87
|
|
88
|
-
#
|
88
|
+
# Delete a Webhook
|
89
89
|
#
|
90
90
|
# @param uuid
|
91
91
|
# @param [Hash] opts the optional parameters
|
@@ -129,7 +129,7 @@ module SignRequestClient
|
|
129
129
|
return data, status_code, headers
|
130
130
|
end
|
131
131
|
|
132
|
-
#
|
132
|
+
# Retrieve a list of Webhooks
|
133
133
|
#
|
134
134
|
# @param [Hash] opts the optional parameters
|
135
135
|
# @option opts [Integer] :page A page number within the paginated result set.
|
@@ -140,7 +140,7 @@ module SignRequestClient
|
|
140
140
|
return data
|
141
141
|
end
|
142
142
|
|
143
|
-
#
|
143
|
+
# Retrieve a list of Webhooks
|
144
144
|
#
|
145
145
|
# @param [Hash] opts the optional parameters
|
146
146
|
# @option opts [Integer] :page A page number within the paginated result set.
|
@@ -184,7 +184,7 @@ module SignRequestClient
|
|
184
184
|
return data, status_code, headers
|
185
185
|
end
|
186
186
|
|
187
|
-
#
|
187
|
+
# Partially update a Webhook
|
188
188
|
#
|
189
189
|
# @param uuid
|
190
190
|
# @param data
|
@@ -195,7 +195,7 @@ module SignRequestClient
|
|
195
195
|
return data
|
196
196
|
end
|
197
197
|
|
198
|
-
#
|
198
|
+
# Partially update a Webhook
|
199
199
|
#
|
200
200
|
# @param uuid
|
201
201
|
# @param data
|
@@ -245,7 +245,7 @@ module SignRequestClient
|
|
245
245
|
return data, status_code, headers
|
246
246
|
end
|
247
247
|
|
248
|
-
#
|
248
|
+
# Retrieve a Webhook
|
249
249
|
#
|
250
250
|
# @param uuid
|
251
251
|
# @param [Hash] opts the optional parameters
|
@@ -255,7 +255,7 @@ module SignRequestClient
|
|
255
255
|
return data
|
256
256
|
end
|
257
257
|
|
258
|
-
#
|
258
|
+
# Retrieve a Webhook
|
259
259
|
#
|
260
260
|
# @param uuid
|
261
261
|
# @param [Hash] opts the optional parameters
|
@@ -300,7 +300,7 @@ module SignRequestClient
|
|
300
300
|
return data, status_code, headers
|
301
301
|
end
|
302
302
|
|
303
|
-
#
|
303
|
+
# Update a Webhook
|
304
304
|
#
|
305
305
|
# @param uuid
|
306
306
|
# @param data
|
@@ -311,7 +311,7 @@ module SignRequestClient
|
|
311
311
|
return data
|
312
312
|
end
|
313
313
|
|
314
|
-
#
|
314
|
+
# Update a Webhook
|
315
315
|
#
|
316
316
|
# @param uuid
|
317
317
|
# @param data
|
@@ -17,54 +17,64 @@ module SignRequestClient
|
|
17
17
|
class Document
|
18
18
|
attr_accessor :url
|
19
19
|
|
20
|
-
attr_accessor :team
|
21
|
-
|
22
20
|
attr_accessor :uuid
|
23
21
|
|
24
22
|
attr_accessor :user
|
25
23
|
|
24
|
+
# Temporary URL to original file as PDF, expires in five minutes
|
26
25
|
attr_accessor :file_as_pdf
|
27
26
|
|
27
|
+
# Defaults to filename, including extension
|
28
28
|
attr_accessor :name
|
29
29
|
|
30
|
+
# ID used to reference document in external system
|
30
31
|
attr_accessor :external_id
|
31
32
|
|
33
|
+
# Shared secret used in conjunction with <a href=\"#section/Frontend-API/SignRequest-js-client-(beta)\">SignRequest-js client</a> to grant user access to a document that's not a member of the document's team
|
32
34
|
attr_accessor :frontend_id
|
33
35
|
|
36
|
+
# Temporary URL to original file, expires in five minutes
|
34
37
|
attr_accessor :file
|
35
38
|
|
39
|
+
# Publicly accessible URL of document to be downloaded by SignRequest
|
36
40
|
attr_accessor :file_from_url
|
37
41
|
|
42
|
+
# URL at which to receive [event callbacks](#section/Events/Events-callback) for this document
|
38
43
|
attr_accessor :events_callback_url
|
39
44
|
|
45
|
+
# Base64 encoded document content
|
40
46
|
attr_accessor :file_from_content
|
41
47
|
|
48
|
+
# Filename, including extension. Required when using `file_from_content`.
|
42
49
|
attr_accessor :file_from_content_name
|
43
50
|
|
44
51
|
attr_accessor :template
|
45
52
|
|
53
|
+
# Prefill signer input data, see [prefill tags](#section/Preparing-a-document/Prefill-tags-templates)
|
46
54
|
attr_accessor :prefill_tags
|
47
55
|
|
48
56
|
attr_accessor :integrations
|
49
57
|
|
50
58
|
attr_accessor :file_from_sf
|
51
59
|
|
60
|
+
# Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted
|
52
61
|
attr_accessor :auto_delete_days
|
53
62
|
|
63
|
+
# Temporary URL to signed document as PDF, expires in five minutes
|
54
64
|
attr_accessor :pdf
|
55
65
|
|
66
|
+
# `co`: converting, `ne`: new, `se`: sent, `vi`: viewed, `si`: signed, `do`: downloaded, `sd`: signed and downloaded, `ca`: cancelled, `de`: declined, `ec`: error converting, `es`: error sending, `xp`: expired
|
56
67
|
attr_accessor :status
|
57
68
|
|
58
|
-
|
59
|
-
|
69
|
+
# Indicates whether document was created using the API
|
60
70
|
attr_accessor :api_used
|
61
71
|
|
62
|
-
|
63
|
-
|
72
|
+
# SHA256 hash of PDF contents
|
64
73
|
attr_accessor :security_hash
|
65
74
|
|
66
75
|
attr_accessor :attachments
|
67
76
|
|
77
|
+
# Date and time calculated using `auto_delete_days` after which a finished document (signed/cancelled/declined) will be automatically deleted
|
68
78
|
attr_accessor :auto_delete_after
|
69
79
|
|
70
80
|
class EnumAttributeValidator
|
@@ -93,7 +103,6 @@ module SignRequestClient
|
|
93
103
|
def self.attribute_map
|
94
104
|
{
|
95
105
|
:'url' => :'url',
|
96
|
-
:'team' => :'team',
|
97
106
|
:'uuid' => :'uuid',
|
98
107
|
:'user' => :'user',
|
99
108
|
:'file_as_pdf' => :'file_as_pdf',
|
@@ -112,9 +121,7 @@ module SignRequestClient
|
|
112
121
|
:'auto_delete_days' => :'auto_delete_days',
|
113
122
|
:'pdf' => :'pdf',
|
114
123
|
:'status' => :'status',
|
115
|
-
:'signrequest' => :'signrequest',
|
116
124
|
:'api_used' => :'api_used',
|
117
|
-
:'signing_log' => :'signing_log',
|
118
125
|
:'security_hash' => :'security_hash',
|
119
126
|
:'attachments' => :'attachments',
|
120
127
|
:'auto_delete_after' => :'auto_delete_after'
|
@@ -125,7 +132,6 @@ module SignRequestClient
|
|
125
132
|
def self.swagger_types
|
126
133
|
{
|
127
134
|
:'url' => :'String',
|
128
|
-
:'team' => :'InlineTeam',
|
129
135
|
:'uuid' => :'String',
|
130
136
|
:'user' => :'User',
|
131
137
|
:'file_as_pdf' => :'String',
|
@@ -144,9 +150,7 @@ module SignRequestClient
|
|
144
150
|
:'auto_delete_days' => :'Integer',
|
145
151
|
:'pdf' => :'String',
|
146
152
|
:'status' => :'String',
|
147
|
-
:'signrequest' => :'InlineSignRequest',
|
148
153
|
:'api_used' => :'BOOLEAN',
|
149
|
-
:'signing_log' => :'SigningLog',
|
150
154
|
:'security_hash' => :'String',
|
151
155
|
:'attachments' => :'Array<DocumentAttachment>',
|
152
156
|
:'auto_delete_after' => :'DateTime'
|
@@ -165,10 +169,6 @@ module SignRequestClient
|
|
165
169
|
self.url = attributes[:'url']
|
166
170
|
end
|
167
171
|
|
168
|
-
if attributes.has_key?(:'team')
|
169
|
-
self.team = attributes[:'team']
|
170
|
-
end
|
171
|
-
|
172
172
|
if attributes.has_key?(:'uuid')
|
173
173
|
self.uuid = attributes[:'uuid']
|
174
174
|
end
|
@@ -245,18 +245,10 @@ module SignRequestClient
|
|
245
245
|
self.status = attributes[:'status']
|
246
246
|
end
|
247
247
|
|
248
|
-
if attributes.has_key?(:'signrequest')
|
249
|
-
self.signrequest = attributes[:'signrequest']
|
250
|
-
end
|
251
|
-
|
252
248
|
if attributes.has_key?(:'api_used')
|
253
249
|
self.api_used = attributes[:'api_used']
|
254
250
|
end
|
255
251
|
|
256
|
-
if attributes.has_key?(:'signing_log')
|
257
|
-
self.signing_log = attributes[:'signing_log']
|
258
|
-
end
|
259
|
-
|
260
252
|
if attributes.has_key?(:'security_hash')
|
261
253
|
self.security_hash = attributes[:'security_hash']
|
262
254
|
end
|
@@ -332,7 +324,7 @@ module SignRequestClient
|
|
332
324
|
return false if !@events_callback_url.nil? && @events_callback_url.to_s.length > 2100
|
333
325
|
return false if !@auto_delete_days.nil? && @auto_delete_days > 730
|
334
326
|
return false if !@auto_delete_days.nil? && @auto_delete_days < 1
|
335
|
-
status_validator = EnumAttributeValidator.new('String', ["co", "ne", "se", "vi", "si", "do", "sd", "ca", "de", "ec", "es"])
|
327
|
+
status_validator = EnumAttributeValidator.new('String', ["co", "ne", "se", "vi", "si", "do", "sd", "ca", "de", "ec", "es", "xp"])
|
336
328
|
return false unless status_validator.valid?(@status)
|
337
329
|
return false if !@security_hash.nil? && @security_hash.to_s.length < 1
|
338
330
|
return true
|
@@ -433,7 +425,7 @@ module SignRequestClient
|
|
433
425
|
# Custom attribute writer method checking allowed values (enum).
|
434
426
|
# @param [Object] status Object to be assigned
|
435
427
|
def status=(status)
|
436
|
-
validator = EnumAttributeValidator.new('String', ["co", "ne", "se", "vi", "si", "do", "sd", "ca", "de", "ec", "es"])
|
428
|
+
validator = EnumAttributeValidator.new('String', ["co", "ne", "se", "vi", "si", "do", "sd", "ca", "de", "ec", "es", "xp"])
|
437
429
|
unless validator.valid?(status)
|
438
430
|
fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
|
439
431
|
end
|
@@ -457,7 +449,6 @@ module SignRequestClient
|
|
457
449
|
return true if self.equal?(o)
|
458
450
|
self.class == o.class &&
|
459
451
|
url == o.url &&
|
460
|
-
team == o.team &&
|
461
452
|
uuid == o.uuid &&
|
462
453
|
user == o.user &&
|
463
454
|
file_as_pdf == o.file_as_pdf &&
|
@@ -476,9 +467,7 @@ module SignRequestClient
|
|
476
467
|
auto_delete_days == o.auto_delete_days &&
|
477
468
|
pdf == o.pdf &&
|
478
469
|
status == o.status &&
|
479
|
-
signrequest == o.signrequest &&
|
480
470
|
api_used == o.api_used &&
|
481
|
-
signing_log == o.signing_log &&
|
482
471
|
security_hash == o.security_hash &&
|
483
472
|
attachments == o.attachments &&
|
484
473
|
auto_delete_after == o.auto_delete_after
|
@@ -493,7 +482,7 @@ module SignRequestClient
|
|
493
482
|
# Calculates hash code according to all attributes.
|
494
483
|
# @return [Fixnum] Hash code
|
495
484
|
def hash
|
496
|
-
[url,
|
485
|
+
[url, uuid, user, file_as_pdf, name, external_id, frontend_id, file, file_from_url, events_callback_url, file_from_content, file_from_content_name, template, prefill_tags, integrations, file_from_sf, auto_delete_days, pdf, status, api_used, security_hash, attachments, auto_delete_after].hash
|
497
486
|
end
|
498
487
|
|
499
488
|
# Builds the object from hash
|