signrequest_client 0.1.0 → 1.0.0
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/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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a472156a0e7cc5888661fd43beffd555b5775e1ac8bc1d122d6ca708e2b44909
|
|
4
|
+
data.tar.gz: 47057a8b472a5bef151df2c20cf8ad3d5d30f33771e616bdb260b795e17013c9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 76530c1511c4af136681bab207eee66ef35fda6a18af33f93623f9f7c4586ec5026806a34f6a3006e85786a853d43c05d32bd81a551f998e51cf1e30a6c2cd83
|
|
7
|
+
data.tar.gz: b830a9beb88e394e35d88aff57a57e86b23b71bca6b9679a630adec23e45c28996945571b3ed4cb59e11a706b6333a63b04799d8b1a5783ea642e6b268d7014f
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -6,9 +6,9 @@ SignRequestClient - the Ruby gem for the SignRequest API
|
|
|
6
6
|
|
|
7
7
|
Add this to the Gemfile:
|
|
8
8
|
|
|
9
|
-
gem 'signrequest_client', '~>
|
|
10
|
-
|
|
11
|
-
And then run:
|
|
9
|
+
gem 'signrequest_client', '~> 1.0.0'
|
|
10
|
+
|
|
11
|
+
And then run:
|
|
12
12
|
|
|
13
13
|
bundle install
|
|
14
14
|
|
|
@@ -24,7 +24,7 @@ SignRequestClient.configure do |config|
|
|
|
24
24
|
end
|
|
25
25
|
|
|
26
26
|
documents_api = SignRequestClient::DocumentsApi.new
|
|
27
|
-
document = SignRequestClient::Document.new
|
|
27
|
+
document = SignRequestClient::Document.new
|
|
28
28
|
|
|
29
29
|
begin
|
|
30
30
|
result = documents_api.documents_create(document)
|
|
@@ -32,53 +32,49 @@ begin
|
|
|
32
32
|
rescue SignRequestClient::ApiError => e
|
|
33
33
|
puts "Exception when calling ApiTokensApi->api_tokens_create: #{e}"
|
|
34
34
|
end
|
|
35
|
-
|
|
36
35
|
```
|
|
37
36
|
|
|
38
37
|
## Documentation for API Endpoints
|
|
39
38
|
|
|
40
|
-
All URIs are relative to
|
|
39
|
+
All URIs are relative to _https://signrequest.com/api/v1_
|
|
41
40
|
|
|
42
41
|
Class | Method | HTTP request | Description
|
|
43
42
|
------------ | ------------- | ------------- | -------------
|
|
44
|
-
*SignRequestClient::ApiTokensApi* | [**api_tokens_create**](docs/ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ |
|
|
45
|
-
*SignRequestClient::ApiTokensApi* | [**api_tokens_delete**](docs/ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ |
|
|
46
|
-
*SignRequestClient::ApiTokensApi* | [**api_tokens_list**](docs/ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ |
|
|
47
|
-
*SignRequestClient::ApiTokensApi* | [**api_tokens_read**](docs/ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ |
|
|
48
|
-
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_create**](docs/DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ |
|
|
49
|
-
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ |
|
|
50
|
-
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_read**](docs/DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ |
|
|
51
|
-
*SignRequestClient::DocumentsApi* | [**documents_create**](docs/DocumentsApi.md#documents_create) | **POST** /documents/ |
|
|
52
|
-
*SignRequestClient::DocumentsApi* | [**documents_delete**](docs/DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ |
|
|
53
|
-
*SignRequestClient::DocumentsApi* | [**
|
|
54
|
-
*SignRequestClient::DocumentsApi* | [**
|
|
55
|
-
*SignRequestClient::
|
|
56
|
-
*SignRequestClient::
|
|
57
|
-
*SignRequestClient::
|
|
58
|
-
*SignRequestClient::
|
|
59
|
-
*SignRequestClient::
|
|
60
|
-
*SignRequestClient::
|
|
61
|
-
*SignRequestClient::SignrequestsApi* | [**
|
|
62
|
-
*SignRequestClient::SignrequestsApi* | [**
|
|
63
|
-
*SignRequestClient::SignrequestsApi* | [**
|
|
64
|
-
*SignRequestClient::
|
|
65
|
-
*SignRequestClient::
|
|
66
|
-
*SignRequestClient::
|
|
67
|
-
*SignRequestClient::
|
|
68
|
-
*SignRequestClient::TeamsApi* | [**
|
|
69
|
-
*SignRequestClient::TeamsApi* | [**
|
|
70
|
-
*SignRequestClient::TeamsApi* | [**
|
|
71
|
-
*SignRequestClient::
|
|
72
|
-
*SignRequestClient::
|
|
73
|
-
*SignRequestClient::
|
|
74
|
-
*SignRequestClient::
|
|
75
|
-
*SignRequestClient::
|
|
76
|
-
*SignRequestClient::WebhooksApi* | [**
|
|
77
|
-
*SignRequestClient::WebhooksApi* | [**
|
|
78
|
-
*SignRequestClient::WebhooksApi* | [**
|
|
79
|
-
*SignRequestClient::WebhooksApi* | [**webhooks_partial_update**](docs/WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ |
|
|
80
|
-
*SignRequestClient::WebhooksApi* | [**webhooks_read**](docs/WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ |
|
|
81
|
-
*SignRequestClient::WebhooksApi* | [**webhooks_update**](docs/WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ |
|
|
43
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_create**](docs/ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ | Create an API token
|
|
44
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_delete**](docs/ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | Delete an API token
|
|
45
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_list**](docs/ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | Retrieve a list of API tokens
|
|
46
|
+
*SignRequestClient::ApiTokensApi* | [**api_tokens_read**](docs/ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | Retrieve an API token
|
|
47
|
+
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_create**](docs/DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ | Create a Document Attachment
|
|
48
|
+
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | Retrieve a list of Document Attachments
|
|
49
|
+
*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_read**](docs/DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ | Retrieve a Document Attachment
|
|
50
|
+
*SignRequestClient::DocumentsApi* | [**documents_create**](docs/DocumentsApi.md#documents_create) | **POST** /documents/ | Create a Document
|
|
51
|
+
*SignRequestClient::DocumentsApi* | [**documents_delete**](docs/DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ | Delete a Document
|
|
52
|
+
*SignRequestClient::DocumentsApi* | [**documents_list**](docs/DocumentsApi.md#documents_list) | **GET** /documents/ | Retrieve a list of Documents
|
|
53
|
+
*SignRequestClient::DocumentsApi* | [**documents_read**](docs/DocumentsApi.md#documents_read) | **GET** /documents/{uuid}/ | Retrieve a Document
|
|
54
|
+
*SignRequestClient::DocumentsSearchApi* | [**documents_search_list**](docs/DocumentsSearchApi.md#documents_search_list) | **GET** /documents-search/ | Search documents
|
|
55
|
+
*SignRequestClient::EventsApi* | [**events_list**](docs/EventsApi.md#events_list) | **GET** /events/ | Retrieve a list of Events
|
|
56
|
+
*SignRequestClient::EventsApi* | [**events_read**](docs/EventsApi.md#events_read) | **GET** /events/{id}/ | Retrieve an Event
|
|
57
|
+
*SignRequestClient::SignrequestQuickCreateApi* | [**signrequest_quick_create_create**](docs/SignrequestQuickCreateApi.md#signrequest_quick_create_create) | **POST** /signrequest-quick-create/ | Quick create a SignRequest
|
|
58
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_cancel_signrequest**](docs/SignrequestsApi.md#signrequests_cancel_signrequest) | **POST** /signrequests/{uuid}/cancel_signrequest/ | Cancel a SignRequest
|
|
59
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_create**](docs/SignrequestsApi.md#signrequests_create) | **POST** /signrequests/ | Create a SignRequest
|
|
60
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_list**](docs/SignrequestsApi.md#signrequests_list) | **GET** /signrequests/ | Retrieve a list of SignRequests
|
|
61
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_read**](docs/SignrequestsApi.md#signrequests_read) | **GET** /signrequests/{uuid}/ | Retrieve a SignRequest
|
|
62
|
+
*SignRequestClient::SignrequestsApi* | [**signrequests_resend_signrequest_email**](docs/SignrequestsApi.md#signrequests_resend_signrequest_email) | **POST** /signrequests/{uuid}/resend_signrequest_email/ | Resend a SignRequest
|
|
63
|
+
*SignRequestClient::TeamMembersApi* | [**team_members_list**](docs/TeamMembersApi.md#team_members_list) | **GET** /team-members/ | Retrieve a list of Team Members
|
|
64
|
+
*SignRequestClient::TeamMembersApi* | [**team_members_read**](docs/TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | Retrieve a Team Member
|
|
65
|
+
*SignRequestClient::TeamsApi* | [**teams_create**](docs/TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team
|
|
66
|
+
*SignRequestClient::TeamsApi* | [**teams_invite_member**](docs/TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member
|
|
67
|
+
*SignRequestClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams
|
|
68
|
+
*SignRequestClient::TeamsApi* | [**teams_partial_update**](docs/TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team
|
|
69
|
+
*SignRequestClient::TeamsApi* | [**teams_read**](docs/TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ | Retrieve a Team
|
|
70
|
+
*SignRequestClient::TemplatesApi* | [**templates_list**](docs/TemplatesApi.md#templates_list) | **GET** /templates/ | Retrieve a list of Templates
|
|
71
|
+
*SignRequestClient::TemplatesApi* | [**templates_read**](docs/TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ | Retrieve a Template
|
|
72
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_create**](docs/WebhooksApi.md#webhooks_create) | **POST** /webhooks/ | Create a Webhook
|
|
73
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_delete**](docs/WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ | Delete a Webhook
|
|
74
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_list**](docs/WebhooksApi.md#webhooks_list) | **GET** /webhooks/ | Retrieve a list of Webhooks
|
|
75
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_partial_update**](docs/WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ | Partially update a Webhook
|
|
76
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_read**](docs/WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ | Retrieve a Webhook
|
|
77
|
+
*SignRequestClient::WebhooksApi* | [**webhooks_update**](docs/WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ | Update a Webhook
|
|
82
78
|
|
|
83
79
|
|
|
84
80
|
## Documentation for Models
|
|
@@ -103,6 +99,8 @@ Class | Method | HTTP request | Description
|
|
|
103
99
|
- [SignRequestClient::InlineResponse2007](docs/InlineResponse2007.md)
|
|
104
100
|
- [SignRequestClient::InlineResponse2008](docs/InlineResponse2008.md)
|
|
105
101
|
- [SignRequestClient::InlineResponse2009](docs/InlineResponse2009.md)
|
|
102
|
+
- [SignRequestClient::InlineResponse201](docs/InlineResponse201.md)
|
|
103
|
+
- [SignRequestClient::InlineResponse2011](docs/InlineResponse2011.md)
|
|
106
104
|
- [SignRequestClient::InlineSignRequest](docs/InlineSignRequest.md)
|
|
107
105
|
- [SignRequestClient::InlineTeam](docs/InlineTeam.md)
|
|
108
106
|
- [SignRequestClient::InlineTeamMember](docs/InlineTeamMember.md)
|
|
@@ -120,3 +118,4 @@ Class | Method | HTTP request | Description
|
|
|
120
118
|
- [SignRequestClient::Template](docs/Template.md)
|
|
121
119
|
- [SignRequestClient::User](docs/User.md)
|
|
122
120
|
- [SignRequestClient::WebhookSubscription](docs/WebhookSubscription.md)
|
|
121
|
+
|
data/docs/ApiTokensApi.md
CHANGED
|
@@ -4,18 +4,18 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**api_tokens_create**](ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ |
|
|
8
|
-
[**api_tokens_delete**](ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ |
|
|
9
|
-
[**api_tokens_list**](ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ |
|
|
10
|
-
[**api_tokens_read**](ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ |
|
|
7
|
+
[**api_tokens_create**](ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ | Create an API token
|
|
8
|
+
[**api_tokens_delete**](ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | Delete an API token
|
|
9
|
+
[**api_tokens_list**](ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | Retrieve a list of API tokens
|
|
10
|
+
[**api_tokens_read**](ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | Retrieve an API token
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
# **api_tokens_create**
|
|
14
14
|
> AuthToken api_tokens_create(data)
|
|
15
15
|
|
|
16
|
+
Create an API token
|
|
16
17
|
|
|
17
|
-
|
|
18
|
-
|
|
18
|
+
You can create an API token in the [team api settings page](/#/teams). It is also possible to get or create a token using the REST api with your login credentials.
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
```ruby
|
|
@@ -35,6 +35,7 @@ data = SignRequestClient::AuthToken.new # AuthToken |
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
begin
|
|
38
|
+
#Create an API token
|
|
38
39
|
result = api_instance.api_tokens_create(data)
|
|
39
40
|
p result
|
|
40
41
|
rescue SignRequestClient::ApiError => e
|
|
@@ -66,7 +67,7 @@ Name | Type | Description | Notes
|
|
|
66
67
|
# **api_tokens_delete**
|
|
67
68
|
> api_tokens_delete(key)
|
|
68
69
|
|
|
69
|
-
|
|
70
|
+
Delete an API token
|
|
70
71
|
|
|
71
72
|
|
|
72
73
|
|
|
@@ -88,6 +89,7 @@ key = "key_example" # String | A unique value identifying this api token.
|
|
|
88
89
|
|
|
89
90
|
|
|
90
91
|
begin
|
|
92
|
+
#Delete an API token
|
|
91
93
|
api_instance.api_tokens_delete(key)
|
|
92
94
|
rescue SignRequestClient::ApiError => e
|
|
93
95
|
puts "Exception when calling ApiTokensApi->api_tokens_delete: #{e}"
|
|
@@ -118,7 +120,7 @@ nil (empty response body)
|
|
|
118
120
|
# **api_tokens_list**
|
|
119
121
|
> InlineResponse200 api_tokens_list(opts)
|
|
120
122
|
|
|
121
|
-
|
|
123
|
+
Retrieve a list of API tokens
|
|
122
124
|
|
|
123
125
|
|
|
124
126
|
|
|
@@ -142,6 +144,7 @@ opts = {
|
|
|
142
144
|
}
|
|
143
145
|
|
|
144
146
|
begin
|
|
147
|
+
#Retrieve a list of API tokens
|
|
145
148
|
result = api_instance.api_tokens_list(opts)
|
|
146
149
|
p result
|
|
147
150
|
rescue SignRequestClient::ApiError => e
|
|
@@ -174,7 +177,7 @@ Name | Type | Description | Notes
|
|
|
174
177
|
# **api_tokens_read**
|
|
175
178
|
> AuthToken api_tokens_read(key)
|
|
176
179
|
|
|
177
|
-
|
|
180
|
+
Retrieve an API token
|
|
178
181
|
|
|
179
182
|
|
|
180
183
|
|
|
@@ -196,6 +199,7 @@ key = "key_example" # String | A unique value identifying this api token.
|
|
|
196
199
|
|
|
197
200
|
|
|
198
201
|
begin
|
|
202
|
+
#Retrieve an API token
|
|
199
203
|
result = api_instance.api_tokens_read(key)
|
|
200
204
|
p result
|
|
201
205
|
rescue SignRequestClient::ApiError => e
|
data/docs/Document.md
CHANGED
|
@@ -4,30 +4,27 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**url** | **String** | | [optional]
|
|
7
|
-
**team** | [**InlineTeam**](InlineTeam.md) | | [optional]
|
|
8
7
|
**uuid** | **String** | | [optional]
|
|
9
8
|
**user** | [**User**](User.md) | | [optional]
|
|
10
|
-
**file_as_pdf** | **String** |
|
|
11
|
-
**name** | **String** |
|
|
12
|
-
**external_id** | **String** |
|
|
13
|
-
**frontend_id** | **String** |
|
|
14
|
-
**file** | **String** |
|
|
15
|
-
**file_from_url** | **String** |
|
|
16
|
-
**events_callback_url** | **String** |
|
|
17
|
-
**file_from_content** | **String** |
|
|
18
|
-
**file_from_content_name** | **String** |
|
|
9
|
+
**file_as_pdf** | **String** | Temporary URL to original file as PDF, expires in five minutes | [optional]
|
|
10
|
+
**name** | **String** | Defaults to filename, including extension | [optional]
|
|
11
|
+
**external_id** | **String** | ID used to reference document in external system | [optional]
|
|
12
|
+
**frontend_id** | **String** | 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 | [optional]
|
|
13
|
+
**file** | **String** | Temporary URL to original file, expires in five minutes | [optional]
|
|
14
|
+
**file_from_url** | **String** | Publicly accessible URL of document to be downloaded by SignRequest | [optional]
|
|
15
|
+
**events_callback_url** | **String** | URL at which to receive [event callbacks](#section/Events/Events-callback) for this document | [optional]
|
|
16
|
+
**file_from_content** | **String** | Base64 encoded document content | [optional]
|
|
17
|
+
**file_from_content_name** | **String** | Filename, including extension. Required when using `file_from_content`. | [optional]
|
|
19
18
|
**template** | **String** | | [optional]
|
|
20
|
-
**prefill_tags** | [**Array<InlinePrefillTags>**](InlinePrefillTags.md) |
|
|
19
|
+
**prefill_tags** | [**Array<InlinePrefillTags>**](InlinePrefillTags.md) | Prefill signer input data, see [prefill tags](#section/Preparing-a-document/Prefill-tags-templates) | [optional]
|
|
21
20
|
**integrations** | [**Array<InlineIntegrationData>**](InlineIntegrationData.md) | | [optional]
|
|
22
21
|
**file_from_sf** | [**FileFromSf**](FileFromSf.md) | | [optional]
|
|
23
|
-
**auto_delete_days** | **Integer** |
|
|
24
|
-
**pdf** | **String** |
|
|
25
|
-
**status** | **String** |
|
|
26
|
-
**
|
|
27
|
-
**
|
|
28
|
-
**signing_log** | [**SigningLog**](SigningLog.md) | | [optional]
|
|
29
|
-
**security_hash** | **String** | | [optional]
|
|
22
|
+
**auto_delete_days** | **Integer** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
|
|
23
|
+
**pdf** | **String** | Temporary URL to signed document as PDF, expires in five minutes | [optional]
|
|
24
|
+
**status** | **String** | `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 | [optional]
|
|
25
|
+
**api_used** | **BOOLEAN** | Indicates whether document was created using the API | [optional]
|
|
26
|
+
**security_hash** | **String** | SHA256 hash of PDF contents | [optional]
|
|
30
27
|
**attachments** | [**Array<DocumentAttachment>**](DocumentAttachment.md) | | [optional]
|
|
31
|
-
**auto_delete_after** | **DateTime** |
|
|
28
|
+
**auto_delete_after** | **DateTime** | Date and time calculated using `auto_delete_days` after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
|
|
32
29
|
|
|
33
30
|
|
data/docs/DocumentAttachment.md
CHANGED
|
@@ -5,11 +5,11 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**url** | **String** | | [optional]
|
|
7
7
|
**uuid** | **String** | | [optional]
|
|
8
|
-
**name** | **String** |
|
|
9
|
-
**file** | **String** |
|
|
10
|
-
**file_from_content** | **String** |
|
|
11
|
-
**file_from_content_name** | **String** |
|
|
12
|
-
**file_from_url** | **String** |
|
|
8
|
+
**name** | **String** | Defaults to filename | [optional]
|
|
9
|
+
**file** | **String** | Temporary URL to document attachment, expires in five minutes | [optional]
|
|
10
|
+
**file_from_content** | **String** | Base64 encoded document content | [optional]
|
|
11
|
+
**file_from_content_name** | **String** | Filename, including extension. Required when using `file_from_content`. | [optional]
|
|
12
|
+
**file_from_url** | **String** | Publicly accessible URL of document to be downloaded by SignRequest | [optional]
|
|
13
13
|
**document** | **String** | |
|
|
14
14
|
|
|
15
15
|
|
|
@@ -4,15 +4,15 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**document_attachments_create**](DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ |
|
|
8
|
-
[**document_attachments_list**](DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ |
|
|
9
|
-
[**document_attachments_read**](DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ |
|
|
7
|
+
[**document_attachments_create**](DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ | Create a Document Attachment
|
|
8
|
+
[**document_attachments_list**](DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | Retrieve a list of Document Attachments
|
|
9
|
+
[**document_attachments_read**](DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ | Retrieve a Document Attachment
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
# **document_attachments_create**
|
|
13
13
|
> DocumentAttachment document_attachments_create(data)
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Create a Document Attachment
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -34,6 +34,7 @@ data = SignRequestClient::DocumentAttachment.new # DocumentAttachment |
|
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
begin
|
|
37
|
+
#Create a Document Attachment
|
|
37
38
|
result = api_instance.document_attachments_create(data)
|
|
38
39
|
p result
|
|
39
40
|
rescue SignRequestClient::ApiError => e
|
|
@@ -65,7 +66,7 @@ Name | Type | Description | Notes
|
|
|
65
66
|
# **document_attachments_list**
|
|
66
67
|
> InlineResponse2001 document_attachments_list(opts)
|
|
67
68
|
|
|
68
|
-
|
|
69
|
+
Retrieve a list of Document Attachments
|
|
69
70
|
|
|
70
71
|
|
|
71
72
|
|
|
@@ -92,6 +93,7 @@ opts = {
|
|
|
92
93
|
}
|
|
93
94
|
|
|
94
95
|
begin
|
|
96
|
+
#Retrieve a list of Document Attachments
|
|
95
97
|
result = api_instance.document_attachments_list(opts)
|
|
96
98
|
p result
|
|
97
99
|
rescue SignRequestClient::ApiError => e
|
|
@@ -127,7 +129,7 @@ Name | Type | Description | Notes
|
|
|
127
129
|
# **document_attachments_read**
|
|
128
130
|
> DocumentAttachment document_attachments_read(uuid)
|
|
129
131
|
|
|
130
|
-
|
|
132
|
+
Retrieve a Document Attachment
|
|
131
133
|
|
|
132
134
|
|
|
133
135
|
|
|
@@ -149,6 +151,7 @@ uuid = "uuid_example" # String |
|
|
|
149
151
|
|
|
150
152
|
|
|
151
153
|
begin
|
|
154
|
+
#Retrieve a Document Attachment
|
|
152
155
|
result = api_instance.document_attachments_read(uuid)
|
|
153
156
|
p result
|
|
154
157
|
rescue SignRequestClient::ApiError => e
|
data/docs/DocumentSearch.md
CHANGED
|
@@ -3,20 +3,20 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**status** | **String** |
|
|
7
|
-
**name** | **String** |
|
|
6
|
+
**status** | **String** | `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 | [optional]
|
|
7
|
+
**name** | **String** | Defaults to filename | [optional]
|
|
8
8
|
**who** | **String** | |
|
|
9
9
|
**nr_extra_docs** | **Integer** | |
|
|
10
10
|
**from_email** | **String** | |
|
|
11
|
-
**parent_doc** | **String** | |
|
|
12
11
|
**uuid** | **String** | | [optional]
|
|
13
12
|
**created** | **DateTime** | | [optional]
|
|
14
13
|
**autocomplete** | **String** | |
|
|
15
|
-
**finished_on** | **DateTime** | |
|
|
16
|
-
**subdomain** | **String** | |
|
|
17
14
|
**signer_emails** | **Array<String>** | | [optional]
|
|
18
15
|
**status_display** | **String** | | [optional]
|
|
19
16
|
**created_timestamp** | **Integer** | | [optional]
|
|
20
17
|
**finished_on_timestamp** | **Integer** | | [optional]
|
|
18
|
+
**parent_doc** | **String** | | [optional]
|
|
19
|
+
**finished_on** | **DateTime** | | [optional]
|
|
20
|
+
**subdomain** | **String** | | [optional]
|
|
21
21
|
|
|
22
22
|
|
data/docs/DocumentsApi.md
CHANGED
|
@@ -4,17 +4,16 @@ All URIs are relative to *https://signrequest.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**documents_create**](DocumentsApi.md#documents_create) | **POST** /documents/ |
|
|
8
|
-
[**documents_delete**](DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ |
|
|
9
|
-
[**
|
|
10
|
-
[**
|
|
11
|
-
[**documents_read**](DocumentsApi.md#documents_read) | **GET** /documents/{uuid}/ |
|
|
7
|
+
[**documents_create**](DocumentsApi.md#documents_create) | **POST** /documents/ | Create a Document
|
|
8
|
+
[**documents_delete**](DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ | Delete a Document
|
|
9
|
+
[**documents_list**](DocumentsApi.md#documents_list) | **GET** /documents/ | Retrieve a list of Documents
|
|
10
|
+
[**documents_read**](DocumentsApi.md#documents_read) | **GET** /documents/{uuid}/ | Retrieve a Document
|
|
12
11
|
|
|
13
12
|
|
|
14
13
|
# **documents_create**
|
|
15
14
|
> Document documents_create(data)
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
Create a Document
|
|
18
17
|
|
|
19
18
|
|
|
20
19
|
|
|
@@ -36,6 +35,7 @@ data = SignRequestClient::Document.new # Document |
|
|
|
36
35
|
|
|
37
36
|
|
|
38
37
|
begin
|
|
38
|
+
#Create a Document
|
|
39
39
|
result = api_instance.documents_create(data)
|
|
40
40
|
p result
|
|
41
41
|
rescue SignRequestClient::ApiError => e
|
|
@@ -67,7 +67,7 @@ Name | Type | Description | Notes
|
|
|
67
67
|
# **documents_delete**
|
|
68
68
|
> documents_delete(uuid)
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
Delete a Document
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
|
|
@@ -89,6 +89,7 @@ uuid = "uuid_example" # String |
|
|
|
89
89
|
|
|
90
90
|
|
|
91
91
|
begin
|
|
92
|
+
#Delete a Document
|
|
92
93
|
api_instance.documents_delete(uuid)
|
|
93
94
|
rescue SignRequestClient::ApiError => e
|
|
94
95
|
puts "Exception when calling DocumentsApi->documents_delete: #{e}"
|
|
@@ -116,66 +117,10 @@ nil (empty response body)
|
|
|
116
117
|
|
|
117
118
|
|
|
118
119
|
|
|
119
|
-
# **documents_delete_files**
|
|
120
|
-
> Document documents_delete_files(uuid, data)
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
This is only for integration partners
|
|
125
|
-
|
|
126
|
-
### Example
|
|
127
|
-
```ruby
|
|
128
|
-
# load the gem
|
|
129
|
-
require 'signrequest_client'
|
|
130
|
-
# setup authorization
|
|
131
|
-
SignRequestClient.configure do |config|
|
|
132
|
-
# Configure API key authorization: Token
|
|
133
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
134
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
135
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
136
|
-
end
|
|
137
|
-
|
|
138
|
-
api_instance = SignRequestClient::DocumentsApi.new
|
|
139
|
-
|
|
140
|
-
uuid = "uuid_example" # String |
|
|
141
|
-
|
|
142
|
-
data = SignRequestClient::Document.new # Document |
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
begin
|
|
146
|
-
result = api_instance.documents_delete_files(uuid, data)
|
|
147
|
-
p result
|
|
148
|
-
rescue SignRequestClient::ApiError => e
|
|
149
|
-
puts "Exception when calling DocumentsApi->documents_delete_files: #{e}"
|
|
150
|
-
end
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
### Parameters
|
|
154
|
-
|
|
155
|
-
Name | Type | Description | Notes
|
|
156
|
-
------------- | ------------- | ------------- | -------------
|
|
157
|
-
**uuid** | **String**| |
|
|
158
|
-
**data** | [**Document**](Document.md)| |
|
|
159
|
-
|
|
160
|
-
### Return type
|
|
161
|
-
|
|
162
|
-
[**Document**](Document.md)
|
|
163
|
-
|
|
164
|
-
### Authorization
|
|
165
|
-
|
|
166
|
-
[Token](../README.md#Token)
|
|
167
|
-
|
|
168
|
-
### HTTP request headers
|
|
169
|
-
|
|
170
|
-
- **Content-Type**: application/json
|
|
171
|
-
- **Accept**: application/json
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
120
|
# **documents_list**
|
|
176
121
|
> InlineResponse2003 documents_list(opts)
|
|
177
122
|
|
|
178
|
-
|
|
123
|
+
Retrieve a list of Documents
|
|
179
124
|
|
|
180
125
|
|
|
181
126
|
|
|
@@ -208,6 +153,7 @@ opts = {
|
|
|
208
153
|
}
|
|
209
154
|
|
|
210
155
|
begin
|
|
156
|
+
#Retrieve a list of Documents
|
|
211
157
|
result = api_instance.documents_list(opts)
|
|
212
158
|
p result
|
|
213
159
|
rescue SignRequestClient::ApiError => e
|
|
@@ -249,7 +195,7 @@ Name | Type | Description | Notes
|
|
|
249
195
|
# **documents_read**
|
|
250
196
|
> Document documents_read(uuid)
|
|
251
197
|
|
|
252
|
-
|
|
198
|
+
Retrieve a Document
|
|
253
199
|
|
|
254
200
|
|
|
255
201
|
|
|
@@ -271,6 +217,7 @@ uuid = "uuid_example" # String |
|
|
|
271
217
|
|
|
272
218
|
|
|
273
219
|
begin
|
|
220
|
+
#Retrieve a Document
|
|
274
221
|
result = api_instance.documents_read(uuid)
|
|
275
222
|
p result
|
|
276
223
|
rescue SignRequestClient::ApiError => e
|