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.
Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +43 -44
  4. data/docs/ApiTokensApi.md +13 -9
  5. data/docs/Document.md +16 -19
  6. data/docs/DocumentAttachment.md +5 -5
  7. data/docs/DocumentAttachmentsApi.md +9 -6
  8. data/docs/DocumentSearch.md +5 -5
  9. data/docs/DocumentsApi.md +12 -65
  10. data/docs/DocumentsSearchApi.md +23 -58
  11. data/docs/Event.md +0 -1
  12. data/docs/EventsApi.md +6 -4
  13. data/docs/InlineResponse201.md +9 -0
  14. data/docs/InlineResponse2011.md +8 -0
  15. data/docs/InlineSignRequest.md +15 -15
  16. data/docs/SignRequest.md +15 -15
  17. data/docs/SignRequestQuickCreate.md +25 -25
  18. data/docs/SignerAttachment.md +1 -1
  19. data/docs/SigningLog.md +2 -2
  20. data/docs/SignrequestQuickCreateApi.md +3 -2
  21. data/docs/SignrequestsApi.md +21 -22
  22. data/docs/TeamMember.md +0 -1
  23. data/docs/TeamMembersApi.md +6 -4
  24. data/docs/TeamsApi.md +20 -72
  25. data/docs/Template.md +2 -3
  26. data/docs/TemplatesApi.md +6 -4
  27. data/docs/WebhookSubscription.md +1 -2
  28. data/docs/WebhooksApi.md +18 -12
  29. data/lib/signrequest_client.rb +2 -0
  30. data/lib/signrequest_client/api/api_tokens_api.rb +10 -10
  31. data/lib/signrequest_client/api/document_attachments_api.rb +6 -6
  32. data/lib/signrequest_client/api/documents_api.rb +8 -69
  33. data/lib/signrequest_client/api/documents_search_api.rb +31 -59
  34. data/lib/signrequest_client/api/events_api.rb +4 -4
  35. data/lib/signrequest_client/api/signrequest_quick_create_api.rb +2 -2
  36. data/lib/signrequest_client/api/signrequests_api.rb +24 -36
  37. data/lib/signrequest_client/api/team_members_api.rb +4 -4
  38. data/lib/signrequest_client/api/teams_api.rb +20 -81
  39. data/lib/signrequest_client/api/templates_api.rb +4 -4
  40. data/lib/signrequest_client/api/webhooks_api.rb +12 -12
  41. data/lib/signrequest_client/models/document.rb +19 -30
  42. data/lib/signrequest_client/models/document_attachment.rb +5 -0
  43. data/lib/signrequest_client/models/document_search.rb +60 -79
  44. data/lib/signrequest_client/models/event.rb +3 -12
  45. data/lib/signrequest_client/models/inline_prefill_tags.rb +1 -1
  46. data/lib/signrequest_client/models/inline_response_201.rb +240 -0
  47. data/lib/signrequest_client/models/inline_response_201_1.rb +226 -0
  48. data/lib/signrequest_client/models/inline_sign_request.rb +46 -38
  49. data/lib/signrequest_client/models/sign_request.rb +15 -0
  50. data/lib/signrequest_client/models/sign_request_quick_create.rb +25 -0
  51. data/lib/signrequest_client/models/signer_attachment.rb +1 -0
  52. data/lib/signrequest_client/models/signing_log.rb +7 -5
  53. data/lib/signrequest_client/models/team_member.rb +1 -10
  54. data/lib/signrequest_client/models/template.rb +3 -10
  55. data/lib/signrequest_client/models/webhook_subscription.rb +4 -12
  56. data/lib/signrequest_client/version.rb +1 -1
  57. data/pkg/signrequest_client-0.1.0.gem +0 -0
  58. data/spec/models/inline_response_201_1_spec.rb +46 -0
  59. data/spec/models/inline_response_201_spec.rb +52 -0
  60. metadata +11 -3
data/docs/DocumentsSearchApi.md CHANGED
@@ -4,16 +4,15 @@ All URIs are relative to *https://signrequest.com/api/v1*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**documents_search_list**](DocumentsSearchApi.md#documents_search_list) | **GET** /documents-search/ |
8
- [**documents_search_read**](DocumentsSearchApi.md#documents_search_read) | **GET** /documents-search/{id}/ |
7
+ [**documents_search_list**](DocumentsSearchApi.md#documents_search_list) | **GET** /documents-search/ | Search documents
9
8
 
10
9
 
11
10
  # **documents_search_list**
12
11
  > InlineResponse2002 documents_search_list(opts)
13
12
 
13
+ Search documents
14
14
 
15
-
16
- ## Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**={{query}} *Autocomplete search:* - ?**autocomplete**={{partial query}} *Search in document name:* - ?**name**={{query}} *Available (extra) filters:* - ?**subdomain**={{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**={{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**={{ si }} - ?**who**={{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status=se|vi** (sent and viewed). *Pagination:* - ?**page**={{ page_number: default 1 }} - ?**limit**={{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**=csv - ?**format**=xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id's found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**=csv&**signer_data**=1 - ?**format**=xls&**signer_data**=1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
15
+ Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**={{query}} *Autocomplete search:* - ?**autocomplete**={{partial query}} *Search in document name:* - ?**name**={{query}} *Available (extra) filters:* - ?**subdomain**={{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**={{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**={{ si }} - ?**who**={{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status=se|vi** (sent and viewed). *Pagination:* - ?**page**={{ page_number: default 1 }} - ?**limit**={{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**=csv - ?**format**=xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id's found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**=csv&**signer_data**=1 - ?**format**=xls&**signer_data**=1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
17
16
 
18
17
  ### Example
19
18
  ```ruby
@@ -31,10 +30,20 @@ api_instance = SignRequestClient::DocumentsSearchApi.new
31
30
 
32
31
  opts = {
33
32
  page: 56, # Integer | A page number within the paginated result set.
34
- limit: 56 # Integer | Number of results to return per page.
33
+ limit: 56, # Integer | Number of results to return per page.
34
+ q: "q_example", # String | Normal search query
35
+ autocomplete: "autocomplete_example", # String | Partial search query
36
+ name: "name_example", # String | Document name
37
+ subdomain: "subdomain_example", # String |
38
+ signer_emails: "signer_emails_example", # String | Email needed to sign/approve
39
+ status: "status_example", # 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
40
+ who: "who_example", # String | `m`: only me, `mo`: me and others, `o`: only others
41
+ format: "format_example", # String | Export format, can be `json` (default), `csv`, or `xls`
42
+ signer_data: 8.14 # Float | Set to `1` to export with each signer on a separate row
35
43
  }
36
44
 
37
45
  begin
46
+ #Search documents
38
47
  result = api_instance.documents_search_list(opts)
39
48
  p result
40
49
  rescue SignRequestClient::ApiError => e
@@ -48,6 +57,15 @@ Name | Type | Description | Notes
48
57
  ------------- | ------------- | ------------- | -------------
49
58
  **page** | **Integer**| A page number within the paginated result set. | [optional]
50
59
  **limit** | **Integer**| Number of results to return per page. | [optional]
60
+ **q** | **String**| Normal search query | [optional]
61
+ **autocomplete** | **String**| Partial search query | [optional]
62
+ **name** | **String**| Document name | [optional]
63
+ **subdomain** | **String**| | [optional]
64
+ **signer_emails** | **String**| Email needed to sign/approve | [optional]
65
+ **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]
66
+ **who** | **String**| `m`: only me, `mo`: me and others, `o`: only others | [optional]
67
+ **format** | **String**| Export format, can be `json` (default), `csv`, or `xls` | [optional]
68
+ **signer_data** | **Float**| Set to `1` to export with each signer on a separate row | [optional]
51
69
 
52
70
  ### Return type
53
71
 
@@ -64,56 +82,3 @@ Name | Type | Description | Notes
64
82
 
65
83
 
66
84
 
67
- # **documents_search_read**
68
- > DocumentSearch documents_search_read(id)
69
-
70
-
71
-
72
- ## Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**={{query}} *Autocomplete search:* - ?**autocomplete**={{partial query}} *Search in document name:* - ?**name**={{query}} *Available (extra) filters:* - ?**subdomain**={{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**={{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**={{ si }} - ?**who**={{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status=se|vi** (sent and viewed). *Pagination:* - ?**page**={{ page_number: default 1 }} - ?**limit**={{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**=csv - ?**format**=xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id's found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**=csv&**signer_data**=1 - ?**format**=xls&**signer_data**=1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
73
-
74
- ### Example
75
- ```ruby
76
- # load the gem
77
- require 'signrequest_client'
78
- # setup authorization
79
- SignRequestClient.configure do |config|
80
- # Configure API key authorization: Token
81
- config.api_key['Authorization'] = 'YOUR API KEY'
82
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
83
- #config.api_key_prefix['Authorization'] = 'Bearer'
84
- end
85
-
86
- api_instance = SignRequestClient::DocumentsSearchApi.new
87
-
88
- id = "id_example" # String |
89
-
90
-
91
- begin
92
- result = api_instance.documents_search_read(id)
93
- p result
94
- rescue SignRequestClient::ApiError => e
95
- puts "Exception when calling DocumentsSearchApi->documents_search_read: #{e}"
96
- end
97
- ```
98
-
99
- ### Parameters
100
-
101
- Name | Type | Description | Notes
102
- ------------- | ------------- | ------------- | -------------
103
- **id** | **String**| |
104
-
105
- ### Return type
106
-
107
- [**DocumentSearch**](DocumentSearch.md)
108
-
109
- ### Authorization
110
-
111
- [Token](../README.md#Token)
112
-
113
- ### HTTP request headers
114
-
115
- - **Content-Type**: application/json
116
- - **Accept**: application/json, text/csv, application/vnd.ms-excel
117
-
118
-
119
-
data/docs/Event.md CHANGED
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
10
10
  **delivered_on** | **DateTime** | | [optional]
11
11
  **callback_status_code** | **Integer** | | [optional]
12
12
  **timestamp** | **DateTime** | | [optional]
13
- **team** | [**InlineTeam**](InlineTeam.md) | | [optional]
14
13
  **document** | [**Document**](Document.md) | | [optional]
15
14
  **signer** | [**Signer**](Signer.md) | | [optional]
16
15
 
data/docs/EventsApi.md CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://signrequest.com/api/v1*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**events_list**](EventsApi.md#events_list) | **GET** /events/ |
8
- [**events_read**](EventsApi.md#events_read) | **GET** /events/{id}/ |
7
+ [**events_list**](EventsApi.md#events_list) | **GET** /events/ | Retrieve a list of Events
8
+ [**events_read**](EventsApi.md#events_read) | **GET** /events/{id}/ | Retrieve an Event
9
9
 
10
10
 
11
11
  # **events_list**
12
12
  > InlineResponse2004 events_list(opts)
13
13
 
14
-
14
+ Retrieve a list of Events
15
15
 
16
16
 
17
17
 
@@ -48,6 +48,7 @@ opts = {
48
48
  }
49
49
 
50
50
  begin
51
+ #Retrieve a list of Events
51
52
  result = api_instance.events_list(opts)
52
53
  p result
53
54
  rescue SignRequestClient::ApiError => e
@@ -93,7 +94,7 @@ Name | Type | Description | Notes
93
94
  # **events_read**
94
95
  > Event events_read(id)
95
96
 
96
-
97
+ Retrieve an Event
97
98
 
98
99
 
99
100
 
@@ -115,6 +116,7 @@ id = 56 # Integer | A unique integer value identifying this event.
115
116
 
116
117
 
117
118
  begin
119
+ #Retrieve an Event
118
120
  result = api_instance.events_read(id)
119
121
  p result
120
122
  rescue SignRequestClient::ApiError => e
data/docs/InlineResponse201.md ADDED
@@ -0,0 +1,9 @@
1
+ # SignRequestClient::InlineResponse201
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cancelled** | **BOOLEAN** | |
7
+ **detail** | **String** | |
8
+
9
+
data/docs/InlineResponse2011.md ADDED
@@ -0,0 +1,8 @@
1
+ # SignRequestClient::InlineResponse2011
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **detail** | **String** | |
7
+
8
+
data/docs/InlineSignRequest.md CHANGED
@@ -3,23 +3,23 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **from_email** | **String** | |
7
- **from_email_name** | **String** | | [optional]
8
- **is_being_prepared** | **BOOLEAN** | | [optional]
6
+ **from_email** | **String** | Email of user sending the SignRequest (must be a validated email) | [optional]
7
+ **from_email_name** | **String** | Name to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>` | [optional]
8
+ **is_being_prepared** | **BOOLEAN** | Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) | [optional]
9
9
  **prepare_url** | **String** | | [optional]
10
- **redirect_url** | **String** | | [optional]
10
+ **redirect_url** | **String** | URL at which SignRequest will redirect to when a document is signed | [optional]
11
11
  **required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | | [optional]
12
- **disable_attachments** | **BOOLEAN** | | [optional]
13
- **disable_text_signatures** | **BOOLEAN** | | [optional]
14
- **disable_text** | **BOOLEAN** | | [optional]
15
- **disable_date** | **BOOLEAN** | | [optional]
16
- **disable_emails** | **BOOLEAN** | | [optional]
17
- **disable_upload_signatures** | **BOOLEAN** | | [optional]
18
- **subject** | **String** | | [optional]
19
- **message** | **String** | | [optional]
20
- **who** | **String** | | [optional]
21
- **send_reminders** | **BOOLEAN** | | [optional]
22
- **signers** | [**Array<Signer>**](Signer.md) | |
12
+ **disable_attachments** | **BOOLEAN** | Disable uploading/adding of attachments | [optional]
13
+ **disable_text_signatures** | **BOOLEAN** | Disable usage of signatures generated by typing (text) | [optional]
14
+ **disable_text** | **BOOLEAN** | Disable adding of text | [optional]
15
+ **disable_date** | **BOOLEAN** | Disable adding of dates | [optional]
16
+ **disable_emails** | **BOOLEAN** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
17
+ **disable_upload_signatures** | **BOOLEAN** | Disable usage of uploaded signatures (images) | [optional]
18
+ **subject** | **String** | Subject of SignRequest email | [optional]
19
+ **message** | **String** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional]
20
+ **who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional]
21
+ **send_reminders** | **BOOLEAN** | Automatically remind signers to sign a document | [optional]
22
+ **signers** | [**Array<Signer>**](Signer.md) | | [optional]
23
23
  **uuid** | **String** | | [optional]
24
24
 
25
25
 
data/docs/SignRequest.md CHANGED
@@ -3,22 +3,22 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **from_email** | **String** | | [optional]
7
- **from_email_name** | **String** | | [optional]
8
- **is_being_prepared** | **BOOLEAN** | | [optional]
6
+ **from_email** | **String** | Email of user sending the SignRequest (must be a validated email) | [optional]
7
+ **from_email_name** | **String** | Name to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>` | [optional]
8
+ **is_being_prepared** | **BOOLEAN** | Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) | [optional]
9
9
  **prepare_url** | **String** | | [optional]
10
- **redirect_url** | **String** | | [optional]
11
- **required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | | [optional]
12
- **disable_attachments** | **BOOLEAN** | | [optional]
13
- **disable_text_signatures** | **BOOLEAN** | | [optional]
14
- **disable_text** | **BOOLEAN** | | [optional]
15
- **disable_date** | **BOOLEAN** | | [optional]
16
- **disable_emails** | **BOOLEAN** | | [optional]
17
- **disable_upload_signatures** | **BOOLEAN** | | [optional]
18
- **subject** | **String** | | [optional]
19
- **message** | **String** | | [optional]
20
- **who** | **String** | | [optional] [default to "o"]
21
- **send_reminders** | **BOOLEAN** | | [optional]
10
+ **redirect_url** | **String** | URL at which SignRequest will redirect to when a document is signed | [optional]
11
+ **required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | Attachments that signers are required to upload | [optional]
12
+ **disable_attachments** | **BOOLEAN** | Disable uploading/adding of attachments | [optional]
13
+ **disable_text_signatures** | **BOOLEAN** | Disable usage of signatures generated by typing (text) | [optional]
14
+ **disable_text** | **BOOLEAN** | Disable adding of text | [optional]
15
+ **disable_date** | **BOOLEAN** | Disable adding of dates | [optional]
16
+ **disable_emails** | **BOOLEAN** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
17
+ **disable_upload_signatures** | **BOOLEAN** | Disable usage of uploaded signatures (images) | [optional]
18
+ **subject** | **String** | Subject of SignRequest email | [optional]
19
+ **message** | **String** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional]
20
+ **who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to "o"]
21
+ **send_reminders** | **BOOLEAN** | Automatically remind signers to sign a document | [optional]
22
22
  **signers** | [**Array<Signer>**](Signer.md) | |
23
23
  **uuid** | **String** | | [optional]
24
24
  **url** | **String** | | [optional]
data/docs/SignRequestQuickCreate.md CHANGED
@@ -3,40 +3,40 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **from_email** | **String** | | [optional]
7
- **from_email_name** | **String** | | [optional]
8
- **is_being_prepared** | **BOOLEAN** | | [optional]
6
+ **from_email** | **String** | Email of user sending the SignRequest (must be a validated email) | [optional]
7
+ **from_email_name** | **String** | Name to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>` | [optional]
8
+ **is_being_prepared** | **BOOLEAN** | Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) | [optional]
9
9
  **prepare_url** | **String** | | [optional]
10
- **redirect_url** | **String** | | [optional]
11
- **required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | | [optional]
12
- **disable_attachments** | **BOOLEAN** | | [optional]
13
- **disable_text_signatures** | **BOOLEAN** | | [optional]
14
- **disable_text** | **BOOLEAN** | | [optional]
15
- **disable_date** | **BOOLEAN** | | [optional]
16
- **disable_emails** | **BOOLEAN** | | [optional]
17
- **disable_upload_signatures** | **BOOLEAN** | | [optional]
18
- **subject** | **String** | | [optional]
19
- **message** | **String** | | [optional]
20
- **who** | **String** | | [optional] [default to "o"]
21
- **send_reminders** | **BOOLEAN** | | [optional]
10
+ **redirect_url** | **String** | URL at which SignRequest will redirect to when a document is signed | [optional]
11
+ **required_attachments** | [**Array<RequiredAttachment>**](RequiredAttachment.md) | Attachments that signers are required to upload | [optional]
12
+ **disable_attachments** | **BOOLEAN** | Disable uploading/adding of attachments | [optional]
13
+ **disable_text_signatures** | **BOOLEAN** | Disable usage of signatures generated by typing (text) | [optional]
14
+ **disable_text** | **BOOLEAN** | Disable adding of text | [optional]
15
+ **disable_date** | **BOOLEAN** | Disable adding of dates | [optional]
16
+ **disable_emails** | **BOOLEAN** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
17
+ **disable_upload_signatures** | **BOOLEAN** | Disable usage of uploaded signatures (images) | [optional]
18
+ **subject** | **String** | Subject of SignRequest email | [optional]
19
+ **message** | **String** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional]
20
+ **who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to "o"]
21
+ **send_reminders** | **BOOLEAN** | Automatically remind signers to sign a document | [optional]
22
22
  **signers** | [**Array<Signer>**](Signer.md) | |
23
23
  **uuid** | **String** | | [optional]
24
24
  **url** | **String** | | [optional]
25
25
  **document** | **String** | | [optional]
26
26
  **integration** | **String** | | [optional]
27
27
  **integration_data** | **String** | | [optional]
28
- **name** | **String** | | [optional]
29
- **external_id** | **String** | | [optional]
30
- **frontend_id** | **String** | | [optional]
31
- **file** | **String** | | [optional]
32
- **file_from_url** | **String** | | [optional]
33
- **events_callback_url** | **String** | | [optional]
34
- **file_from_content** | **String** | | [optional]
35
- **file_from_content_name** | **String** | | [optional]
28
+ **name** | **String** | Defaults to filename, including extension | [optional]
29
+ **external_id** | **String** | ID used to reference document in external system | [optional]
30
+ **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]
31
+ **file** | **String** | Temporary URL to original file, expires in five minutes | [optional]
32
+ **file_from_url** | **String** | Publicly accessible URL of document to be downloaded by SignRequest | [optional]
33
+ **events_callback_url** | **String** | URL at which to receive [event callbacks](#section/Events/Events-callback) for this document | [optional]
34
+ **file_from_content** | **String** | Base64 encoded document content | [optional]
35
+ **file_from_content_name** | **String** | Filename, including extension. Required when using `file_from_content`. | [optional]
36
36
  **template** | **String** | | [optional]
37
- **prefill_tags** | [**Array<InlinePrefillTags>**](InlinePrefillTags.md) | | [optional]
37
+ **prefill_tags** | [**Array<InlinePrefillTags>**](InlinePrefillTags.md) | Prefill signer input data, see [prefill tags](#section/Preparing-a-document/Prefill-tags-templates) | [optional]
38
38
  **integrations** | [**Array<InlineIntegrationData>**](InlineIntegrationData.md) | | [optional]
39
39
  **file_from_sf** | [**FileFromSf**](FileFromSf.md) | | [optional]
40
- **auto_delete_days** | **Integer** | | [optional]
40
+ **auto_delete_days** | **Integer** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
41
41
 
42
42
 
data/docs/SignerAttachment.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **uuid** | **String** | | [optional]
7
- **name** | **String** | | [optional]
7
+ **name** | **String** | Defaults to filename | [optional]
8
8
  **file** | **String** | | [optional]
9
9
  **for_attachment** | [**RequiredAttachment**](RequiredAttachment.md) | | [optional]
10
10
 
data/docs/SigningLog.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **pdf** | **String** | | [optional]
7
- **security_hash** | **String** | | [optional]
6
+ **pdf** | **String** | Temporary URL to signing log, expires in five minutes | [optional]
7
+ **security_hash** | **String** | SHA256 hash of PDF contents | [optional]
8
8
 
9
9
 
data/docs/SignrequestQuickCreateApi.md CHANGED
@@ -4,13 +4,13 @@ All URIs are relative to *https://signrequest.com/api/v1*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**signrequest_quick_create_create**](SignrequestQuickCreateApi.md#signrequest_quick_create_create) | **POST** /signrequest-quick-create/ |
7
+ [**signrequest_quick_create_create**](SignrequestQuickCreateApi.md#signrequest_quick_create_create) | **POST** /signrequest-quick-create/ | Quick create a SignRequest
8
8
 
9
9
 
10
10
  # **signrequest_quick_create_create**
11
11
  > SignRequestQuickCreate signrequest_quick_create_create(data)
12
12
 
13
-
13
+ Quick create a SignRequest
14
14
 
15
15
 
16
16
 
@@ -32,6 +32,7 @@ data = SignRequestClient::SignRequestQuickCreate.new # SignRequestQuickCreate |
32
32
 
33
33
 
34
34
  begin
35
+ #Quick create a SignRequest
35
36
  result = api_instance.signrequest_quick_create_create(data)
36
37
  p result
37
38
  rescue SignRequestClient::ApiError => e
data/docs/SignrequestsApi.md CHANGED
@@ -4,17 +4,17 @@ All URIs are relative to *https://signrequest.com/api/v1*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**signrequests_cancel_signrequest**](SignrequestsApi.md#signrequests_cancel_signrequest) | **POST** /signrequests/{uuid}/cancel_signrequest/ |
8
- [**signrequests_create**](SignrequestsApi.md#signrequests_create) | **POST** /signrequests/ |
9
- [**signrequests_list**](SignrequestsApi.md#signrequests_list) | **GET** /signrequests/ |
10
- [**signrequests_read**](SignrequestsApi.md#signrequests_read) | **GET** /signrequests/{uuid}/ |
11
- [**signrequests_resend_signrequest_email**](SignrequestsApi.md#signrequests_resend_signrequest_email) | **POST** /signrequests/{uuid}/resend_signrequest_email/ |
7
+ [**signrequests_cancel_signrequest**](SignrequestsApi.md#signrequests_cancel_signrequest) | **POST** /signrequests/{uuid}/cancel_signrequest/ | Cancel a SignRequest
8
+ [**signrequests_create**](SignrequestsApi.md#signrequests_create) | **POST** /signrequests/ | Create a SignRequest
9
+ [**signrequests_list**](SignrequestsApi.md#signrequests_list) | **GET** /signrequests/ | Retrieve a list of SignRequests
10
+ [**signrequests_read**](SignrequestsApi.md#signrequests_read) | **GET** /signrequests/{uuid}/ | Retrieve a SignRequest
11
+ [**signrequests_resend_signrequest_email**](SignrequestsApi.md#signrequests_resend_signrequest_email) | **POST** /signrequests/{uuid}/resend_signrequest_email/ | Resend a SignRequest
12
12
 
13
13
 
14
14
  # **signrequests_cancel_signrequest**
15
- > SignRequest signrequests_cancel_signrequest(uuid, data)
16
-
15
+ > InlineResponse201 signrequests_cancel_signrequest(uuid)
17
16
 
17
+ Cancel a SignRequest
18
18
 
19
19
 
20
20
 
@@ -34,11 +34,10 @@ api_instance = SignRequestClient::SignrequestsApi.new
34
34
 
35
35
  uuid = "uuid_example" # String |
36
36
 
37
- data = SignRequestClient::SignRequest.new # SignRequest |
38
-
39
37
 
40
38
  begin
41
- result = api_instance.signrequests_cancel_signrequest(uuid, data)
39
+ #Cancel a SignRequest
40
+ result = api_instance.signrequests_cancel_signrequest(uuid)
42
41
  p result
43
42
  rescue SignRequestClient::ApiError => e
44
43
  puts "Exception when calling SignrequestsApi->signrequests_cancel_signrequest: #{e}"
@@ -50,11 +49,10 @@ end
50
49
  Name | Type | Description | Notes
51
50
  ------------- | ------------- | ------------- | -------------
52
51
  **uuid** | **String**| |
53
- **data** | [**SignRequest**](SignRequest.md)| |
54
52
 
55
53
  ### Return type
56
54
 
57
- [**SignRequest**](SignRequest.md)
55
+ [**InlineResponse201**](InlineResponse201.md)
58
56
 
59
57
  ### Authorization
60
58
 
@@ -70,7 +68,7 @@ Name | Type | Description | Notes
70
68
  # **signrequests_create**
71
69
  > SignRequest signrequests_create(data)
72
70
 
73
-
71
+ Create a SignRequest
74
72
 
75
73
 
76
74
 
@@ -92,6 +90,7 @@ data = SignRequestClient::SignRequest.new # SignRequest |
92
90
 
93
91
 
94
92
  begin
93
+ #Create a SignRequest
95
94
  result = api_instance.signrequests_create(data)
96
95
  p result
97
96
  rescue SignRequestClient::ApiError => e
@@ -123,7 +122,7 @@ Name | Type | Description | Notes
123
122
  # **signrequests_list**
124
123
  > InlineResponse2005 signrequests_list(opts)
125
124
 
126
-
125
+ Retrieve a list of SignRequests
127
126
 
128
127
 
129
128
 
@@ -149,6 +148,7 @@ opts = {
149
148
  }
150
149
 
151
150
  begin
151
+ #Retrieve a list of SignRequests
152
152
  result = api_instance.signrequests_list(opts)
153
153
  p result
154
154
  rescue SignRequestClient::ApiError => e
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
183
183
  # **signrequests_read**
184
184
  > SignRequest signrequests_read(uuid)
185
185
 
186
-
186
+ Retrieve a SignRequest
187
187
 
188
188
 
189
189
 
@@ -205,6 +205,7 @@ uuid = "uuid_example" # String |
205
205
 
206
206
 
207
207
  begin
208
+ #Retrieve a SignRequest
208
209
  result = api_instance.signrequests_read(uuid)
209
210
  p result
210
211
  rescue SignRequestClient::ApiError => e
@@ -234,9 +235,9 @@ Name | Type | Description | Notes
234
235
 
235
236
 
236
237
  # **signrequests_resend_signrequest_email**
237
- > SignRequest signrequests_resend_signrequest_email(uuid, data)
238
-
238
+ > InlineResponse2011 signrequests_resend_signrequest_email(uuid)
239
239
 
240
+ Resend a SignRequest
240
241
 
241
242
 
242
243
 
@@ -256,11 +257,10 @@ api_instance = SignRequestClient::SignrequestsApi.new
256
257
 
257
258
  uuid = "uuid_example" # String |
258
259
 
259
- data = SignRequestClient::SignRequest.new # SignRequest |
260
-
261
260
 
262
261
  begin
263
- result = api_instance.signrequests_resend_signrequest_email(uuid, data)
262
+ #Resend a SignRequest
263
+ result = api_instance.signrequests_resend_signrequest_email(uuid)
264
264
  p result
265
265
  rescue SignRequestClient::ApiError => e
266
266
  puts "Exception when calling SignrequestsApi->signrequests_resend_signrequest_email: #{e}"
@@ -272,11 +272,10 @@ end
272
272
  Name | Type | Description | Notes
273
273
  ------------- | ------------- | ------------- | -------------
274
274
  **uuid** | **String**| |
275
- **data** | [**SignRequest**](SignRequest.md)| |
276
275
 
277
276
  ### Return type
278
277
 
279
- [**SignRequest**](SignRequest.md)
278
+ [**InlineResponse2011**](InlineResponse2011.md)
280
279
 
281
280
  ### Authorization
282
281