signrequest_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a472156a0e7cc5888661fd43beffd555b5775e1ac8bc1d122d6ca708e2b44909
-  data.tar.gz: 47057a8b472a5bef151df2c20cf8ad3d5d30f33771e616bdb260b795e17013c9
+  metadata.gz: ba5a2bf2d5e9448a5dbdcc0598056afd9ac6d21acdb424a2281797b064f31077
+  data.tar.gz: 19ae33b219d95ee0b2379f05a8ff4736e935712711e7a9dbdf59cfa5a94ea2c4
 SHA512:
-  metadata.gz: 76530c1511c4af136681bab207eee66ef35fda6a18af33f93623f9f7c4586ec5026806a34f6a3006e85786a853d43c05d32bd81a551f998e51cf1e30a6c2cd83
-  data.tar.gz: b830a9beb88e394e35d88aff57a57e86b23b71bca6b9679a630adec23e45c28996945571b3ed4cb59e11a706b6333a63b04799d8b1a5783ea642e6b268d7014f
+  metadata.gz: c0cb1a8ffebed00918c654e3ba2f2b9ffd2166159c4dd342a2b81c44345f9e485f771ec783b00694a86958be82ec675a059349c1f3fa16959d87518fd5c36c5b
+  data.tar.gz: 94f28073c1cb0a6b44cf0354650a9abcd1dde579de28259655d7e35106e69e3877f5b8d40e6b5787d17653755ebca986e5cbda26b3dd9ea7547781d1bb9f76ca

data/README.md

@@ -1,17 +1,24 @@
-# SignRequest API Client
+# SignRequest Ruby Client
 
-SignRequestClient - the Ruby gem for the SignRequest API
+SignRequestClient - the offical Ruby client for [SignRequest.com](https://signrequest.com/)
+
+[![Gem Version](https://badge.fury.io/rb/signrequest_client.svg)](https://badge.fury.io/rb/signrequest_client)
 
 ## Installation
 
 Add this to the Gemfile:
 
-    gem 'signrequest_client', '~> 1.0.0'
+    gem 'signrequest_client', '~> 1.1.0'
 
 And then run:
 
     bundle install
 
+## API Documentation
+
+Full API documentation, including code samples, can be found here:
+https://signrequest.com/api/v1/docs/
+
 ## Getting Started
 
 The client needs to be configured with an API token from your [team api settings page](https://signrequest.com/#/teams).
@@ -25,6 +32,7 @@ end
 
 documents_api = SignRequestClient::DocumentsApi.new
 document = SignRequestClient::Document.new
+document.file_from_url = 'https://docs.google.com/document/d/1oI2R1SxfMNZXiz3jCQvorpoklF9xq_dCJnOpkI-zo80/edit?usp=sharing'
 
 begin
   result = documents_api.documents_create(document)
@@ -36,14 +44,11 @@ end
 
 ## Documentation for API Endpoints
 
-All URIs are relative to _https://signrequest.com/api/v1_
+All URIs are relative to *https://signrequest.com/api/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*SignRequestClient::ApiTokensApi* | [**api_tokens_create**](docs/ApiTokensApi.md#api_tokens_create) | **POST** /api-tokens/ | Create an API token
-*SignRequestClient::ApiTokensApi* | [**api_tokens_delete**](docs/ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | Delete an API token
 *SignRequestClient::ApiTokensApi* | [**api_tokens_list**](docs/ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | Retrieve a list of API tokens
-*SignRequestClient::ApiTokensApi* | [**api_tokens_read**](docs/ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | Retrieve an API token
 *SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_create**](docs/DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ | Create a Document Attachment
 *SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | Retrieve a list of Document Attachments
 *SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_read**](docs/DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ | Retrieve a Document Attachment
@@ -63,6 +68,7 @@ Class | Method | HTTP request | Description
 *SignRequestClient::TeamMembersApi* | [**team_members_list**](docs/TeamMembersApi.md#team_members_list) | **GET** /team-members/ | Retrieve a list of Team Members
 *SignRequestClient::TeamMembersApi* | [**team_members_read**](docs/TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | Retrieve a Team Member
 *SignRequestClient::TeamsApi* | [**teams_create**](docs/TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team
+*SignRequestClient::TeamsApi* | [**teams_delete**](docs/TeamsApi.md#teams_delete) | **DELETE** /teams/{subdomain}/ | Delete a Team
 *SignRequestClient::TeamsApi* | [**teams_invite_member**](docs/TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member
 *SignRequestClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams
 *SignRequestClient::TeamsApi* | [**teams_partial_update**](docs/TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team
@@ -84,6 +90,9 @@ Class | Method | HTTP request | Description
  - [SignRequestClient::DocumentAttachment](docs/DocumentAttachment.md)
  - [SignRequestClient::DocumentSearch](docs/DocumentSearch.md)
  - [SignRequestClient::DocumentSignerTemplateConf](docs/DocumentSignerTemplateConf.md)
+ - [SignRequestClient::DocumentSigningLog](docs/DocumentSigningLog.md)
+ - [SignRequestClient::DocumentSignrequest](docs/DocumentSignrequest.md)
+ - [SignRequestClient::DocumentTeam](docs/DocumentTeam.md)
  - [SignRequestClient::Event](docs/Event.md)
  - [SignRequestClient::FileFromSf](docs/FileFromSf.md)
  - [SignRequestClient::InlineDocumentSignerIntegrationData](docs/InlineDocumentSignerIntegrationData.md)
@@ -119,3 +128,13 @@ Class | Method | HTTP request | Description
  - [SignRequestClient::User](docs/User.md)
  - [SignRequestClient::WebhookSubscription](docs/WebhookSubscription.md)
 
+
+## Documentation for Authorization
+
+
+### Token
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -1,5 +1,4 @@
 begin
-  require 'bundler/gem_tasks'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new(:spec)

data/docs/ApiTokensApi.md

@@ -4,117 +4,7 @@ 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
-```ruby
-# load the gem
-require 'signrequest_client'
-# setup authorization
-SignRequestClient.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = SignRequestClient::ApiTokensApi.new
-
-data = SignRequestClient::AuthToken.new # AuthToken | 
-
-
-begin
-  #Create an API token
-  result = api_instance.api_tokens_create(data)
-  p result
-rescue SignRequestClient::ApiError => e
-  puts "Exception when calling ApiTokensApi->api_tokens_create: #{e}"
-end
-```
-
-### 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
-
-
-
-# **api_tokens_delete**
-> api_tokens_delete(key)
-
-Delete an API token
-
-
-
-### Example
-```ruby
-# load the gem
-require 'signrequest_client'
-# setup authorization
-SignRequestClient.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = SignRequestClient::ApiTokensApi.new
-
-key = "key_example" # String | A unique value identifying this api token.
-
-
-begin
-  #Delete an API token
-  api_instance.api_tokens_delete(key)
-rescue SignRequestClient::ApiError => e
-  puts "Exception when calling ApiTokensApi->api_tokens_delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **key** | **String**| A unique value identifying this api token. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
 
 
 # **api_tokens_list**
@@ -174,57 +64,3 @@ Name | Type | Description  | Notes
 
 
 
-# **api_tokens_read**
-> AuthToken api_tokens_read(key)
-
-Retrieve an API token
-
-
-
-### Example
-```ruby
-# load the gem
-require 'signrequest_client'
-# setup authorization
-SignRequestClient.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
-end
-
-api_instance = SignRequestClient::ApiTokensApi.new
-
-key = "key_example" # String | A unique value identifying this api token.
-
-
-begin
-  #Retrieve an API token
-  result = api_instance.api_tokens_read(key)
-  p result
-rescue SignRequestClient::ApiError => e
-  puts "Exception when calling ApiTokensApi->api_tokens_read: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **key** | **String**| 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
-
-
-

data/docs/Document.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** |  | [optional] 
+**team** | [**DocumentTeam**](DocumentTeam.md) |  | [optional] 
 **uuid** | **String** |  | [optional] 
 **user** | [**User**](User.md) |  | [optional] 
 **file_as_pdf** | **String** | Temporary URL to original file as PDF, expires in five minutes | [optional] 
@@ -20,11 +21,16 @@ Name | Type | Description | Notes
 **integrations** | [**Array<InlineIntegrationData>**](InlineIntegrationData.md) |  | [optional] 
 **file_from_sf** | [**FileFromSf**](FileFromSf.md) |  | [optional] 
 **auto_delete_days** | **Integer** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional] 
+**auto_expire_days** | **Integer** | Number of days after which a non finished document will be automatically expired | [optional] 
 **pdf** | **String** | Temporary URL to signed document as PDF, expires in five minutes | [optional] 
 **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] 
+**signrequest** | [**DocumentSignrequest**](DocumentSignrequest.md) |  | [optional] 
 **api_used** | **BOOLEAN** | Indicates whether document was created using the API | [optional] 
+**signing_log** | [**DocumentSigningLog**](DocumentSigningLog.md) |  | [optional] 
 **security_hash** | **String** | SHA256 hash of PDF contents | [optional] 
 **attachments** | [**Array<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** | **BOOLEAN** | 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] 
 
 

data/docs/DocumentAttachment.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** |  | [optional] 
 **uuid** | **String** |  | [optional] 
-**name** | **String** | Defaults to filename | [optional] 
+**name** | **String** | Defaults to filename, including extension | [optional] 
 **file** | **String** | Temporary URL to document attachment, expires in five minutes | [optional] 
 **file_from_content** | **String** | Base64 encoded document content | [optional] 
 **file_from_content_name** | **String** | Filename, including extension. Required when using `file_from_content`. | [optional] 

data/docs/DocumentAttachmentsApi.md

@@ -85,9 +85,9 @@ end
 api_instance = SignRequestClient::DocumentAttachmentsApi.new
 
 opts = { 
-  document__uuid: "document__uuid_example", # String | 
-  document__external_id: "document__external_id_example", # String | 
-  created: "created_example", # String | 
+  document__uuid: 'document__uuid_example', # String | 
+  document__external_id: 'document__external_id_example', # String | 
+  created: 'created_example', # String | 
   page: 56, # Integer | A page number within the paginated result set.
   limit: 56 # Integer | Number of results to return per page.
 }
@@ -147,7 +147,7 @@ end
 
 api_instance = SignRequestClient::DocumentAttachmentsApi.new
 
-uuid = "uuid_example" # String | 
+uuid = 'uuid_example' # String | 
 
 
 begin

data/docs/DocumentSearch.md

@@ -3,14 +3,14 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
-**name** | **String** | Defaults to filename | [optional] 
-**who** | **String** |  | 
-**nr_extra_docs** | **Integer** |  | 
-**from_email** | **String** |  | 
 **uuid** | **String** |  | [optional] 
 **created** | **DateTime** |  | [optional] 
+**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] 
+**who** | **String** |  | 
+**name** | **String** | Defaults to filename | [optional] 
 **autocomplete** | **String** |  | 
+**from_email** | **String** |  | 
+**nr_extra_docs** | **Integer** |  | 
 **signer_emails** | **Array<String>** |  | [optional] 
 **status_display** | **String** |  | [optional] 
 **created_timestamp** | **Integer** |  | [optional] 

data/docs/DocumentSigningLog.md

@@ -0,0 +1,9 @@
+# SignRequestClient::DocumentSigningLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pdf** | **String** | Temporary URL to signing log, expires in five minutes | [optional] 
+**security_hash** | **String** | SHA256 hash of PDF contents | [optional] 
+
+

data/docs/DocumentSignrequest.md

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

data/docs/DocumentTeam.md

@@ -0,0 +1,10 @@
+# SignRequestClient::DocumentTeam
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**subdomain** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/DocumentsApi.md

@@ -85,7 +85,7 @@ end
 
 api_instance = SignRequestClient::DocumentsApi.new
 
-uuid = "uuid_example" # String | 
+uuid = 'uuid_example' # String | 
 
 
 begin
@@ -139,15 +139,15 @@ end
 api_instance = SignRequestClient::DocumentsApi.new
 
 opts = { 
-  external_id: "external_id_example", # String | 
-  signrequest__who: "signrequest__who_example", # String | 
-  signrequest__from_email: "signrequest__from_email_example", # String | 
-  status: "status_example", # String | 
-  user__email: "user__email_example", # String | 
-  user__first_name: "user__first_name_example", # String | 
-  user__last_name: "user__last_name_example", # String | 
-  created: "created_example", # String | 
-  modified: "modified_example", # String | 
+  external_id: 'external_id_example', # String | 
+  signrequest__who: 'signrequest__who_example', # String | 
+  signrequest__from_email: 'signrequest__from_email_example', # String | 
+  status: 'status_example', # String | 
+  user__email: 'user__email_example', # String | 
+  user__first_name: 'user__first_name_example', # String | 
+  user__last_name: 'user__last_name_example', # String | 
+  created: 'created_example', # String | 
+  modified: 'modified_example', # String | 
   page: 56, # Integer | A page number within the paginated result set.
   limit: 56 # Integer | Number of results to return per page.
 }
@@ -213,7 +213,7 @@ end
 
 api_instance = SignRequestClient::DocumentsApi.new
 
-uuid = "uuid_example" # String | 
+uuid = 'uuid_example' # String | 
 
 
 begin