Skip to content

Commit

Permalink
Merge pull request #7 from SignRequest/v2.0.0
Browse files Browse the repository at this point in the history
v2.0.0
  • Loading branch information
Chris Jackson authored Sep 27, 2019
2 parents c68d58c + 69c1e57 commit a84fc7b
Show file tree
Hide file tree
Showing 86 changed files with 5,160 additions and 688 deletions.
2 changes: 1 addition & 1 deletion .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.3.1
2.4.8
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,11 @@ from signrequest_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
signrequest_client.configuration = signrequest_client.Configuration()
signrequest_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
signrequest_client.configuration.api_key_prefix['Authorization'] = 'Token'
default_configuration = signrequest_client.Configuration()
default_configuration.api_key['Authorization'] = 'YOUR_API_KEY'
default_configuration.api_key_prefix['Authorization'] = 'Token'
signrequest_client.Configuration.set_default(default_configuration)

# create an instance of the API class
api_instance = signrequest_client.DocumentsApi()
data = signrequest_client.Document(
Expand All @@ -75,10 +77,7 @@ All URIs are relative to *https://signrequest.com/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApiTokensApi* | [**api_tokens_create**](docs/ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ | Create an API token
*ApiTokensApi* | [**api_tokens_delete**](docs/ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | Delete an API token
*ApiTokensApi* | [**api_tokens_list**](docs/ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | Retrieve a list of API tokens
*ApiTokensApi* | [**api_tokens_read**](docs/ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | Retrieve an API token
*DocumentAttachmentsApi* | [**document_attachments_create**](docs/DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ | Create a Document Attachment
*DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | Retrieve a list of Document Attachments
*DocumentAttachmentsApi* | [**document_attachments_read**](docs/DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ | Retrieve a Document Attachment
Expand All @@ -98,6 +97,7 @@ Class | Method | HTTP request | Description
*TeamMembersApi* | [**team_members_list**](docs/TeamMembersApi.md#team_members_list) | **GET** /team-members/ | Retrieve a list of Team Members
*TeamMembersApi* | [**team_members_read**](docs/TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | Retrieve a Team Member
*TeamsApi* | [**teams_create**](docs/TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team
*TeamsApi* | [**teams_delete**](docs/TeamsApi.md#teams_delete) | **DELETE** /teams/{subdomain}/ | Delete a Team
*TeamsApi* | [**teams_invite_member**](docs/TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member
*TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams
*TeamsApi* | [**teams_partial_update**](docs/TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team
Expand All @@ -119,6 +119,9 @@ Class | Method | HTTP request | Description
- [DocumentAttachment](docs/DocumentAttachment.md)
- [DocumentSearch](docs/DocumentSearch.md)
- [DocumentSignerTemplateConf](docs/DocumentSignerTemplateConf.md)
- [DocumentSigningLog](docs/DocumentSigningLog.md)
- [DocumentSignrequest](docs/DocumentSignrequest.md)
- [DocumentTeam](docs/DocumentTeam.md)
- [Event](docs/Event.md)
- [FileFromSf](docs/FileFromSf.md)
- [InlineDocumentSignerIntegrationData](docs/InlineDocumentSignerIntegrationData.md)
Expand Down
161 changes: 0 additions & 161 deletions docs/ApiTokensApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,117 +4,9 @@ All URIs are relative to *https://signrequest.com/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**api_tokens_create**](ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ | Create an API token
[**api_tokens_delete**](ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | Delete an API token
[**api_tokens_list**](ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | Retrieve a list of API tokens
[**api_tokens_read**](ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | Retrieve an API token


# **api_tokens_create**
> AuthToken api_tokens_create(data)
Create an API token

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.

### Example
```python
from __future__ import print_function
import time
import signrequest_client
from signrequest_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
configuration = signrequest_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Token'

# create an instance of the API class
api_instance = signrequest_client.ApiTokensApi(signrequest_client.ApiClient(configuration))
data = signrequest_client.AuthToken() # AuthToken |

try:
# Create an API token
api_response = api_instance.api_tokens_create(data)
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiTokensApi->api_tokens_create: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**AuthToken**](AuthToken.md)| |

### Return type

[**AuthToken**](AuthToken.md)

### Authorization

[Token](../README.md#Token)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)

# **api_tokens_delete**
> api_tokens_delete(key)
Delete an API token



### Example
```python
from __future__ import print_function
import time
import signrequest_client
from signrequest_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
configuration = signrequest_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Token'

# create an instance of the API class
api_instance = signrequest_client.ApiTokensApi(signrequest_client.ApiClient(configuration))
key = 'key_example' # str | A unique value identifying this api token.

try:
# Delete an API token
api_instance.api_tokens_delete(key)
except ApiException as e:
print("Exception when calling ApiTokensApi->api_tokens_delete: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**key** | **str**| A unique value identifying this api token. |

### Return type

void (empty response body)

### Authorization

[Token](../README.md#Token)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)

# **api_tokens_list**
> InlineResponse200 api_tokens_list(page=page, limit=limit)
Expand Down Expand Up @@ -170,56 +62,3 @@ Name | Type | Description | Notes

[[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)

# **api_tokens_read**
> AuthToken api_tokens_read(key)
Retrieve an API token



### Example
```python
from __future__ import print_function
import time
import signrequest_client
from signrequest_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
configuration = signrequest_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Token'

# create an instance of the API class
api_instance = signrequest_client.ApiTokensApi(signrequest_client.ApiClient(configuration))
key = 'key_example' # str | A unique value identifying this api token.

try:
# Retrieve an API token
api_response = api_instance.api_tokens_read(key)
pprint(api_response)
except ApiException as e:
print("Exception when calling ApiTokensApi->api_tokens_read: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**key** | **str**| A unique value identifying this api token. |

### Return type

[**AuthToken**](AuthToken.md)

### Authorization

[Token](../README.md#Token)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)

6 changes: 6 additions & 0 deletions docs/Document.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **str** | | [optional]
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
**uuid** | **str** | | [optional]
**user** | [**User**](User.md) | | [optional]
**file_as_pdf** | **str** | Temporary URL to original file as PDF, expires in five minutes | [optional]
Expand All @@ -20,12 +21,17 @@ Name | Type | Description | Notes
**integrations** | [**list[InlineIntegrationData]**](InlineIntegrationData.md) | | [optional]
**file_from_sf** | [**FileFromSf**](FileFromSf.md) | | [optional]
**auto_delete_days** | **int** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional]
**auto_expire_days** | **int** | Number of days after which a non finished document will be automatically expired | [optional]
**pdf** | **str** | Temporary URL to signed document as PDF, expires in five minutes | [optional]
**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]
**signrequest** | [**DocumentSignrequest**](DocumentSignrequest.md) | | [optional]
**api_used** | **bool** | Indicates whether document was created using the API | [optional]
**signing_log** | [**DocumentSigningLog**](DocumentSigningLog.md) | | [optional]
**security_hash** | **str** | SHA256 hash of PDF contents | [optional]
**attachments** | [**list[DocumentAttachment]**](DocumentAttachment.md) | | [optional]
**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]
**sandbox** | **bool** | Indicates whether document was created as part of a sandbox team | [optional]
**auto_expire_after** | **datetime** | Date and time calculated using `auto_expire_days` after which a non finished document will be automatically expired | [optional]

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

Expand Down
2 changes: 1 addition & 1 deletion docs/DocumentAttachment.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **str** | | [optional]
**uuid** | **str** | | [optional]
**name** | **str** | Defaults to filename | [optional]
**name** | **str** | Defaults to filename, including extension | [optional]
**file** | **str** | Temporary URL to document attachment, expires in five minutes | [optional]
**file_from_content** | **str** | Base64 encoded document content | [optional]
**file_from_content_name** | **str** | Filename, including extension. Required when using `file_from_content`. | [optional]
Expand Down
10 changes: 5 additions & 5 deletions docs/DocumentSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**name** | **str** | Defaults to filename | [optional]
**who** | **str** | |
**nr_extra_docs** | **int** | |
**from_email** | **str** | |
**uuid** | **str** | | [optional]
**created** | **datetime** | | [optional]
**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]
**who** | **str** | |
**name** | **str** | Defaults to filename | [optional]
**autocomplete** | **str** | |
**from_email** | **str** | |
**nr_extra_docs** | **int** | |
**signer_emails** | **list[str]** | | [optional]
**status_display** | **str** | | [optional]
**created_timestamp** | **int** | | [optional]
Expand Down
11 changes: 11 additions & 0 deletions docs/DocumentSigningLog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# DocumentSigningLog

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pdf** | **str** | Temporary URL to signing log, expires in five minutes | [optional]
**security_hash** | **str** | SHA256 hash of PDF contents | [optional]

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


30 changes: 30 additions & 0 deletions docs/DocumentSignrequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# DocumentSignrequest

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**from_email** | **str** | Email of user sending the SignRequest (must be a validated email) | [optional]
**from_email_name** | **str** | Name to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>` | [optional]
**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]
**prepare_url** | **str** | | [optional]
**redirect_url** | **str** | URL at which SignRequest will redirect to when a document is signed | [optional]
**redirect_url_declined** | **str** | URL at which SignRequest will redirect to when a document is declined | [optional]
**required_attachments** | [**list[RequiredAttachment]**](RequiredAttachment.md) | | [optional]
**disable_attachments** | **bool** | Disable uploading/adding of attachments | [optional]
**disable_text_signatures** | **bool** | Disable usage of signatures generated by typing (text) | [optional]
**disable_text** | **bool** | Disable adding of text | [optional]
**disable_date** | **bool** | Disable adding of dates | [optional]
**disable_emails** | **bool** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional]
**disable_upload_signatures** | **bool** | Disable usage of uploaded signatures (images) | [optional]
**disable_blockchain_proof** | **bool** | Disables storing timestamp proof hashes in blockchain integrations. | [optional]
**text_message_verification_locked** | **bool** | When true a text message verification is needed before the signer can see the document | [optional]
**subject** | **str** | Subject of SignRequest email | [optional]
**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]
**who** | **str** | `m`: only me, `mo`: me and others, `o`: only others | [optional]
**send_reminders** | **bool** | Automatically remind signers to sign a document | [optional]
**signers** | [**list[Signer]**](Signer.md) | | [optional]
**uuid** | **str** | | [optional]

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


12 changes: 12 additions & 0 deletions docs/DocumentTeam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DocumentTeam

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**subdomain** | **str** | | [optional]
**url** | **str** | | [optional]

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


1 change: 1 addition & 0 deletions docs/Event.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**delivered_on** | **datetime** | | [optional]
**callback_status_code** | **int** | | [optional]
**timestamp** | **datetime** | | [optional]
**team** | [**DocumentTeam**](DocumentTeam.md) | | [optional]
**document** | [**Document**](Document.md) | | [optional]
**signer** | [**Signer**](Signer.md) | | [optional]

Expand Down
1 change: 1 addition & 0 deletions docs/FileFromSf.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**object_type** | **str** | |
**object_id** | **str** | |
**uid** | **str** | | [optional]

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

Expand Down
2 changes: 1 addition & 1 deletion docs/InlineResponse201.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cancelled** | **bool** | |
**detail** | **str** | |
**cancelled** | **bool** | |

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

Expand Down
Loading

0 comments on commit a84fc7b

Please sign in to comment.