Skip to content

Commit a84fc7b

Browse files
author
Chris Jackson
authored
Merge pull request #7 from SignRequest/v2.0.0
v2.0.0
2 parents c68d58c + 69c1e57 commit a84fc7b

File tree

86 files changed

+5160
-688
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+5160
-688
lines changed

‎.swagger-codegen/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.3.1
1+
2.4.8

‎README.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,11 @@ from signrequest_client.rest import ApiException
5050
from pprint import pprint
5151

5252
# Configure API key authorization: Token
53-
signrequest_client.configuration = signrequest_client.Configuration()
54-
signrequest_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
55-
signrequest_client.configuration.api_key_prefix['Authorization'] = 'Token'
53+
default_configuration = signrequest_client.Configuration()
54+
default_configuration.api_key['Authorization'] = 'YOUR_API_KEY'
55+
default_configuration.api_key_prefix['Authorization'] = 'Token'
56+
signrequest_client.Configuration.set_default(default_configuration)
57+
5658
# create an instance of the API class
5759
api_instance = signrequest_client.DocumentsApi()
5860
data = signrequest_client.Document(
@@ -75,10 +77,7 @@ All URIs are relative to *https://signrequest.com/api/v1*
7577

7678
Class | Method | HTTP request | Description
7779
------------ | ------------- | ------------- | -------------
78-
*ApiTokensApi* | [**api_tokens_create**](docs/ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ | Create an API token
79-
*ApiTokensApi* | [**api_tokens_delete**](docs/ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | Delete an API token
8080
*ApiTokensApi* | [**api_tokens_list**](docs/ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | Retrieve a list of API tokens
81-
*ApiTokensApi* | [**api_tokens_read**](docs/ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | Retrieve an API token
8281
*DocumentAttachmentsApi* | [**document_attachments_create**](docs/DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ | Create a Document Attachment
8382
*DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | Retrieve a list of Document Attachments
8483
*DocumentAttachmentsApi* | [**document_attachments_read**](docs/DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ | Retrieve a Document Attachment
@@ -98,6 +97,7 @@ Class | Method | HTTP request | Description
9897
*TeamMembersApi* | [**team_members_list**](docs/TeamMembersApi.md#team_members_list) | **GET** /team-members/ | Retrieve a list of Team Members
9998
*TeamMembersApi* | [**team_members_read**](docs/TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | Retrieve a Team Member
10099
*TeamsApi* | [**teams_create**](docs/TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team
100+
*TeamsApi* | [**teams_delete**](docs/TeamsApi.md#teams_delete) | **DELETE** /teams/{subdomain}/ | Delete a Team
101101
*TeamsApi* | [**teams_invite_member**](docs/TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member
102102
*TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams
103103
*TeamsApi* | [**teams_partial_update**](docs/TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team
@@ -119,6 +119,9 @@ Class | Method | HTTP request | Description
119119
- [DocumentAttachment](docs/DocumentAttachment.md)
120120
- [DocumentSearch](docs/DocumentSearch.md)
121121
- [DocumentSignerTemplateConf](docs/DocumentSignerTemplateConf.md)
122+
- [DocumentSigningLog](docs/DocumentSigningLog.md)
123+
- [DocumentSignrequest](docs/DocumentSignrequest.md)
124+
- [DocumentTeam](docs/DocumentTeam.md)
122125
- [Event](docs/Event.md)
123126
- [FileFromSf](docs/FileFromSf.md)
124127
- [InlineDocumentSignerIntegrationData](docs/InlineDocumentSignerIntegrationData.md)

‎docs/ApiTokensApi.md‎

Lines changed: 0 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -4,117 +4,9 @@ All URIs are relative to *https://signrequest.com/api/v1*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
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
97
[**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
118

129

13-
# **api_tokens_create**
14-
> AuthToken api_tokens_create(data)
15-
16-
Create an API token
17-
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-
20-
### Example
21-
```python
22-
from __future__ import print_function
23-
import time
24-
import signrequest_client
25-
from signrequest_client.rest import ApiException
26-
from pprint import pprint
27-
28-
# Configure API key authorization: Token
29-
configuration = signrequest_client.Configuration()
30-
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
31-
configuration.api_key_prefix['Authorization'] = 'Token'
32-
33-
# create an instance of the API class
34-
api_instance = signrequest_client.ApiTokensApi(signrequest_client.ApiClient(configuration))
35-
data = signrequest_client.AuthToken() # AuthToken |
36-
37-
try:
38-
# Create an API token
39-
api_response = api_instance.api_tokens_create(data)
40-
pprint(api_response)
41-
except ApiException as e:
42-
print("Exception when calling ApiTokensApi->api_tokens_create: %s\n" % e)
43-
```
44-
45-
### Parameters
46-
47-
Name | Type | Description | Notes
48-
------------- | ------------- | ------------- | -------------
49-
**data** | [**AuthToken**](AuthToken.md)| |
50-
51-
### Return type
52-
53-
[**AuthToken**](AuthToken.md)
54-
55-
### Authorization
56-
57-
[Token](../README.md#Token)
58-
59-
### HTTP request headers
60-
61-
- **Content-Type**: application/json
62-
- **Accept**: application/json
63-
64-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
65-
66-
# **api_tokens_delete**
67-
> api_tokens_delete(key)
68-
69-
Delete an API token
70-
71-
72-
73-
### Example
74-
```python
75-
from __future__ import print_function
76-
import time
77-
import signrequest_client
78-
from signrequest_client.rest import ApiException
79-
from pprint import pprint
80-
81-
# Configure API key authorization: Token
82-
configuration = signrequest_client.Configuration()
83-
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
84-
configuration.api_key_prefix['Authorization'] = 'Token'
85-
86-
# create an instance of the API class
87-
api_instance = signrequest_client.ApiTokensApi(signrequest_client.ApiClient(configuration))
88-
key = 'key_example' # str | A unique value identifying this api token.
89-
90-
try:
91-
# Delete an API token
92-
api_instance.api_tokens_delete(key)
93-
except ApiException as e:
94-
print("Exception when calling ApiTokensApi->api_tokens_delete: %s\n" % e)
95-
```
96-
97-
### Parameters
98-
99-
Name | Type | Description | Notes
100-
------------- | ------------- | ------------- | -------------
101-
**key** | **str**| A unique value identifying this api token. |
102-
103-
### Return type
104-
105-
void (empty response body)
106-
107-
### Authorization
108-
109-
[Token](../README.md#Token)
110-
111-
### HTTP request headers
112-
113-
- **Content-Type**: application/json
114-
- **Accept**: application/json
115-
116-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
117-
11810
# **api_tokens_list**
11911
> InlineResponse200 api_tokens_list(page=page, limit=limit)
12012
@@ -170,56 +62,3 @@ Name | Type | Description | Notes
17062

17163
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
17264

173-
# **api_tokens_read**
174-
> AuthToken api_tokens_read(key)
175-
176-
Retrieve an API token
177-
178-
179-
180-
### Example
181-
```python
182-
from __future__ import print_function
183-
import time
184-
import signrequest_client
185-
from signrequest_client.rest import ApiException
186-
from pprint import pprint
187-
188-
# Configure API key authorization: Token
189-
configuration = signrequest_client.Configuration()
190-
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
191-
configuration.api_key_prefix['Authorization'] = 'Token'
192-
193-
# create an instance of the API class
194-
api_instance = signrequest_client.ApiTokensApi(signrequest_client.ApiClient(configuration))
195-
key = 'key_example' # str | A unique value identifying this api token.
196-
197-
try:
198-
# Retrieve an API token
199-
api_response = api_instance.api_tokens_read(key)
200-
pprint(api_response)
201-
except ApiException as e:
202-
print("Exception when calling ApiTokensApi->api_tokens_read: %s\n" % e)
203-
```
204-
205-
### Parameters
206-
207-
Name | Type | Description | Notes
208-
------------- | ------------- | ------------- | -------------
209-
**key** | **str**| A unique value identifying this api token. |
210-
211-
### Return type
212-
213-
[**AuthToken**](AuthToken.md)
214-
215-
### Authorization
216-
217-
[Token](../README.md#Token)
218-
219-
### HTTP request headers
220-
221-
- **Content-Type**: application/json
222-
- **Accept**: application/json
223-
224-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
225-

‎docs/Document.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**url** | **str** | | [optional]
7+
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
78
**uuid** | **str** | | [optional]
89
**user** | [**User**](User.md) | | [optional]
910
**file_as_pdf** | **str** | Temporary URL to original file as PDF, expires in five minutes | [optional]
@@ -20,12 +21,17 @@ Name | Type | Description | Notes
2021
**integrations** | [**list[InlineIntegrationData]**](InlineIntegrationData.md) | | [optional]
2122
**file_from_sf** | [**FileFromSf**](FileFromSf.md) | | [optional]
2223
**auto_delete_days** | **int** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
24+
**auto_expire_days** | **int** | Number of days after which a non finished document will be automatically expired | [optional]
2325
**pdf** | **str** | Temporary URL to signed document as PDF, expires in five minutes | [optional]
2426
**status** | **str** | `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]
27+
**signrequest** | [**DocumentSignrequest**](DocumentSignrequest.md) | | [optional]
2528
**api_used** | **bool** | Indicates whether document was created using the API | [optional]
29+
**signing_log** | [**DocumentSigningLog**](DocumentSigningLog.md) | | [optional]
2630
**security_hash** | **str** | SHA256 hash of PDF contents | [optional]
2731
**attachments** | [**list[DocumentAttachment]**](DocumentAttachment.md) | | [optional]
2832
**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]
33+
**sandbox** | **bool** | Indicates whether document was created as part of a sandbox team | [optional]
34+
**auto_expire_after** | **datetime** | Date and time calculated using `auto_expire_days` after which a non finished document will be automatically expired | [optional]
2935

3036
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3137

‎docs/DocumentAttachment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**url** | **str** | | [optional]
77
**uuid** | **str** | | [optional]
8-
**name** | **str** | Defaults to filename | [optional]
8+
**name** | **str** | Defaults to filename, including extension | [optional]
99
**file** | **str** | Temporary URL to document attachment, expires in five minutes | [optional]
1010
**file_from_content** | **str** | Base64 encoded document content | [optional]
1111
**file_from_content_name** | **str** | Filename, including extension. Required when using `file_from_content`. | [optional]

‎docs/DocumentSearch.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**status** | **str** | `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** | **str** | Defaults to filename | [optional]
8-
**who** | **str** | |
9-
**nr_extra_docs** | **int** | |
10-
**from_email** | **str** | |
116
**uuid** | **str** | | [optional]
127
**created** | **datetime** | | [optional]
8+
**status** | **str** | `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]
9+
**who** | **str** | |
10+
**name** | **str** | Defaults to filename | [optional]
1311
**autocomplete** | **str** | |
12+
**from_email** | **str** | |
13+
**nr_extra_docs** | **int** | |
1414
**signer_emails** | **list[str]** | | [optional]
1515
**status_display** | **str** | | [optional]
1616
**created_timestamp** | **int** | | [optional]

‎docs/DocumentSigningLog.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# DocumentSigningLog
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**pdf** | **str** | Temporary URL to signing log, expires in five minutes | [optional]
7+
**security_hash** | **str** | SHA256 hash of PDF contents | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/DocumentSignrequest.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# DocumentSignrequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**from_email** | **str** | Email of user sending the SignRequest (must be a validated email) | [optional]
7+
**from_email_name** | **str** | Name to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>` | [optional]
8+
**is_being_prepared** | **bool** | 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+
**prepare_url** | **str** | | [optional]
10+
**redirect_url** | **str** | URL at which SignRequest will redirect to when a document is signed | [optional]
11+
**redirect_url_declined** | **str** | URL at which SignRequest will redirect to when a document is declined | [optional]
12+
**required_attachments** | [**list[RequiredAttachment]**](RequiredAttachment.md) | | [optional]
13+
**disable_attachments** | **bool** | Disable uploading/adding of attachments | [optional]
14+
**disable_text_signatures** | **bool** | Disable usage of signatures generated by typing (text) | [optional]
15+
**disable_text** | **bool** | Disable adding of text | [optional]
16+
**disable_date** | **bool** | Disable adding of dates | [optional]
17+
**disable_emails** | **bool** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
18+
**disable_upload_signatures** | **bool** | Disable usage of uploaded signatures (images) | [optional]
19+
**disable_blockchain_proof** | **bool** | Disables storing timestamp proof hashes in blockchain integrations. | [optional]
20+
**text_message_verification_locked** | **bool** | When true a text message verification is needed before the signer can see the document | [optional]
21+
**subject** | **str** | Subject of SignRequest email | [optional]
22+
**message** | **str** | 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]
23+
**who** | **str** | `m`: only me, `mo`: me and others, `o`: only others | [optional]
24+
**send_reminders** | **bool** | Automatically remind signers to sign a document | [optional]
25+
**signers** | [**list[Signer]**](Signer.md) | | [optional]
26+
**uuid** | **str** | | [optional]
27+
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/DocumentTeam.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# DocumentTeam
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | | [optional]
7+
**subdomain** | **str** | | [optional]
8+
**url** | **str** | | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/Event.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
1010
**delivered_on** | **datetime** | | [optional]
1111
**callback_status_code** | **int** | | [optional]
1212
**timestamp** | **datetime** | | [optional]
13+
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
1314
**document** | [**Document**](Document.md) | | [optional]
1415
**signer** | [**Signer**](Signer.md) | | [optional]
1516

0 commit comments

Comments
 (0)