signrequest_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26f17ff60820d3181caabb570d2c758c9e51a266a39fadd90d0465213c20b544
+  data.tar.gz: 724e2cde0d6fb1e17f5a90361bafe7fc312b0f7e27cdb50f15888985652f4bbc
+SHA512:
+  metadata.gz: c00d8bf08cff5b479cca7df186208ecef6048afd43dc9f818a5d6b9c3e9be63394ca06ac906313fc83a3b312c22e6b6eb32ebf3fc45d47877211ec4da65fcb59
+  data.tar.gz: 89e223bc6481989e3641b19024eea50871d39fbfe2627e532bc2d5bca62dfebcffdbbd95f248567f510c8778a8a4325fe6703c4dea4f8326a287e1392588502c

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    signrequest_client (0.1.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.13)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  signrequest_client!
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018 - SignRequest B.V. (https://signrequest.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,122 @@
+# SignRequest API Client
+
+SignRequestClient - the Ruby gem for the SignRequest API
+
+## Installation
+
+Add this to the Gemfile:
+
+    gem 'signrequest_client', '~> 0.1.0'
+    
+And then run: 
+
+    bundle install
+
+## Getting Started
+
+The client needs to be configured with an API token from your [team api settings page](https://signrequest.com/#/teams).
+
+```ruby
+# Setup authorization
+SignRequestClient.configure do |config|
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'Token'
+end
+
+documents_api = SignRequestClient::DocumentsApi.new
+document = SignRequestClient::Document.new 
+
+begin
+  result = documents_api.documents_create(document)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling ApiTokensApi->api_tokens_create: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+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/ | 
+*SignRequestClient::ApiTokensApi* | [**api_tokens_delete**](docs/ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | 
+*SignRequestClient::ApiTokensApi* | [**api_tokens_list**](docs/ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | 
+*SignRequestClient::ApiTokensApi* | [**api_tokens_read**](docs/ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | 
+*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_create**](docs/DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ | 
+*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_list**](docs/DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | 
+*SignRequestClient::DocumentAttachmentsApi* | [**document_attachments_read**](docs/DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ | 
+*SignRequestClient::DocumentsApi* | [**documents_create**](docs/DocumentsApi.md#documents_create) | **POST** /documents/ | 
+*SignRequestClient::DocumentsApi* | [**documents_delete**](docs/DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ | 
+*SignRequestClient::DocumentsApi* | [**documents_delete_files**](docs/DocumentsApi.md#documents_delete_files) | **POST** /documents/{uuid}/delete_files/ | 
+*SignRequestClient::DocumentsApi* | [**documents_list**](docs/DocumentsApi.md#documents_list) | **GET** /documents/ | 
+*SignRequestClient::DocumentsApi* | [**documents_read**](docs/DocumentsApi.md#documents_read) | **GET** /documents/{uuid}/ | 
+*SignRequestClient::DocumentsSearchApi* | [**documents_search_list**](docs/DocumentsSearchApi.md#documents_search_list) | **GET** /documents-search/ | 
+*SignRequestClient::DocumentsSearchApi* | [**documents_search_read**](docs/DocumentsSearchApi.md#documents_search_read) | **GET** /documents-search/{id}/ | 
+*SignRequestClient::EventsApi* | [**events_list**](docs/EventsApi.md#events_list) | **GET** /events/ | 
+*SignRequestClient::EventsApi* | [**events_read**](docs/EventsApi.md#events_read) | **GET** /events/{id}/ | 
+*SignRequestClient::SignrequestQuickCreateApi* | [**signrequest_quick_create_create**](docs/SignrequestQuickCreateApi.md#signrequest_quick_create_create) | **POST** /signrequest-quick-create/ | 
+*SignRequestClient::SignrequestsApi* | [**signrequests_cancel_signrequest**](docs/SignrequestsApi.md#signrequests_cancel_signrequest) | **POST** /signrequests/{uuid}/cancel_signrequest/ | 
+*SignRequestClient::SignrequestsApi* | [**signrequests_create**](docs/SignrequestsApi.md#signrequests_create) | **POST** /signrequests/ | 
+*SignRequestClient::SignrequestsApi* | [**signrequests_list**](docs/SignrequestsApi.md#signrequests_list) | **GET** /signrequests/ | 
+*SignRequestClient::SignrequestsApi* | [**signrequests_read**](docs/SignrequestsApi.md#signrequests_read) | **GET** /signrequests/{uuid}/ | 
+*SignRequestClient::SignrequestsApi* | [**signrequests_resend_signrequest_email**](docs/SignrequestsApi.md#signrequests_resend_signrequest_email) | **POST** /signrequests/{uuid}/resend_signrequest_email/ | 
+*SignRequestClient::TeamMembersApi* | [**team_members_list**](docs/TeamMembersApi.md#team_members_list) | **GET** /team-members/ | 
+*SignRequestClient::TeamMembersApi* | [**team_members_read**](docs/TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | 
+*SignRequestClient::TeamsApi* | [**teams_create**](docs/TeamsApi.md#teams_create) | **POST** /teams/ | 
+*SignRequestClient::TeamsApi* | [**teams_invite_member**](docs/TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | 
+*SignRequestClient::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /teams/ | 
+*SignRequestClient::TeamsApi* | [**teams_partial_update**](docs/TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | 
+*SignRequestClient::TeamsApi* | [**teams_read**](docs/TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ | 
+*SignRequestClient::TeamsApi* | [**teams_update**](docs/TeamsApi.md#teams_update) | **PUT** /teams/{subdomain}/ | 
+*SignRequestClient::TemplatesApi* | [**templates_list**](docs/TemplatesApi.md#templates_list) | **GET** /templates/ | 
+*SignRequestClient::TemplatesApi* | [**templates_read**](docs/TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ | 
+*SignRequestClient::WebhooksApi* | [**webhooks_create**](docs/WebhooksApi.md#webhooks_create) | **POST** /webhooks/ | 
+*SignRequestClient::WebhooksApi* | [**webhooks_delete**](docs/WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ | 
+*SignRequestClient::WebhooksApi* | [**webhooks_list**](docs/WebhooksApi.md#webhooks_list) | **GET** /webhooks/ | 
+*SignRequestClient::WebhooksApi* | [**webhooks_partial_update**](docs/WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ | 
+*SignRequestClient::WebhooksApi* | [**webhooks_read**](docs/WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ | 
+*SignRequestClient::WebhooksApi* | [**webhooks_update**](docs/WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ | 
+
+
+## Documentation for Models
+
+ - [SignRequestClient::AuthToken](docs/AuthToken.md)
+ - [SignRequestClient::Document](docs/Document.md)
+ - [SignRequestClient::DocumentAttachment](docs/DocumentAttachment.md)
+ - [SignRequestClient::DocumentSearch](docs/DocumentSearch.md)
+ - [SignRequestClient::DocumentSignerTemplateConf](docs/DocumentSignerTemplateConf.md)
+ - [SignRequestClient::Event](docs/Event.md)
+ - [SignRequestClient::FileFromSf](docs/FileFromSf.md)
+ - [SignRequestClient::InlineDocumentSignerIntegrationData](docs/InlineDocumentSignerIntegrationData.md)
+ - [SignRequestClient::InlineIntegrationData](docs/InlineIntegrationData.md)
+ - [SignRequestClient::InlinePrefillTags](docs/InlinePrefillTags.md)
+ - [SignRequestClient::InlineResponse200](docs/InlineResponse200.md)
+ - [SignRequestClient::InlineResponse2001](docs/InlineResponse2001.md)
+ - [SignRequestClient::InlineResponse2002](docs/InlineResponse2002.md)
+ - [SignRequestClient::InlineResponse2003](docs/InlineResponse2003.md)
+ - [SignRequestClient::InlineResponse2004](docs/InlineResponse2004.md)
+ - [SignRequestClient::InlineResponse2005](docs/InlineResponse2005.md)
+ - [SignRequestClient::InlineResponse2006](docs/InlineResponse2006.md)
+ - [SignRequestClient::InlineResponse2007](docs/InlineResponse2007.md)
+ - [SignRequestClient::InlineResponse2008](docs/InlineResponse2008.md)
+ - [SignRequestClient::InlineResponse2009](docs/InlineResponse2009.md)
+ - [SignRequestClient::InlineSignRequest](docs/InlineSignRequest.md)
+ - [SignRequestClient::InlineTeam](docs/InlineTeam.md)
+ - [SignRequestClient::InlineTeamMember](docs/InlineTeamMember.md)
+ - [SignRequestClient::InviteMember](docs/InviteMember.md)
+ - [SignRequestClient::Placeholder](docs/Placeholder.md)
+ - [SignRequestClient::RequiredAttachment](docs/RequiredAttachment.md)
+ - [SignRequestClient::SignRequest](docs/SignRequest.md)
+ - [SignRequestClient::SignRequestQuickCreate](docs/SignRequestQuickCreate.md)
+ - [SignRequestClient::Signer](docs/Signer.md)
+ - [SignRequestClient::SignerAttachment](docs/SignerAttachment.md)
+ - [SignRequestClient::SignerInputs](docs/SignerInputs.md)
+ - [SignRequestClient::SigningLog](docs/SigningLog.md)
+ - [SignRequestClient::Team](docs/Team.md)
+ - [SignRequestClient::TeamMember](docs/TeamMember.md)
+ - [SignRequestClient::Template](docs/Template.md)
+ - [SignRequestClient::User](docs/User.md)
+ - [SignRequestClient::WebhookSubscription](docs/WebhookSubscription.md)

data/Rakefile

@@ -0,0 +1,9 @@
+begin
+  require 'bundler/gem_tasks'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ApiTokensApi.md

@@ -0,0 +1,226 @@
+# SignRequestClient::ApiTokensApi
+
+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/ | 
+[**api_tokens_delete**](ApiTokensApi.md#api_tokens_delete) | **DELETE** /api-tokens/{key}/ | 
+[**api_tokens_list**](ApiTokensApi.md#api_tokens_list) | **GET** /api-tokens/ | 
+[**api_tokens_read**](ApiTokensApi.md#api_tokens_read) | **GET** /api-tokens/{key}/ | 
+
+
+# **api_tokens_create**
+> AuthToken api_tokens_create(data)
+
+
+
+
+
+### 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
+  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)
+
+
+
+
+
+### 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
+  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**
+> InlineResponse200 api_tokens_list(opts)
+
+
+
+
+
+### 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
+
+opts = { 
+  page: 56, # Integer | A page number within the paginated result set.
+  limit: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  result = api_instance.api_tokens_list(opts)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling ApiTokensApi->api_tokens_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **api_tokens_read**
+> AuthToken api_tokens_read(key)
+
+
+
+
+
+### 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
+  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/AuthToken.md

@@ -0,0 +1,13 @@
+# SignRequestClient::AuthToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | [optional] 
+**password** | **String** |  | [optional] 
+**subdomain** | **String** |  | 
+**name** | **String** |  | [optional] 
+**key** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/Document.md

@@ -0,0 +1,33 @@
+# SignRequestClient::Document
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | [optional] 
+**team** | [**InlineTeam**](InlineTeam.md) |  | [optional] 
+**uuid** | **String** |  | [optional] 
+**user** | [**User**](User.md) |  | [optional] 
+**file_as_pdf** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**frontend_id** | **String** |  | [optional] 
+**file** | **String** |  | [optional] 
+**file_from_url** | **String** |  | [optional] 
+**events_callback_url** | **String** |  | [optional] 
+**file_from_content** | **String** |  | [optional] 
+**file_from_content_name** | **String** |  | [optional] 
+**template** | **String** |  | [optional] 
+**prefill_tags** | [**Array<InlinePrefillTags>**](InlinePrefillTags.md) |  | [optional] 
+**integrations** | [**Array<InlineIntegrationData>**](InlineIntegrationData.md) |  | [optional] 
+**file_from_sf** | [**FileFromSf**](FileFromSf.md) |  | [optional] 
+**auto_delete_days** | **Integer** |  | [optional] 
+**pdf** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**signrequest** | [**InlineSignRequest**](InlineSignRequest.md) |  | [optional] 
+**api_used** | **BOOLEAN** |  | [optional] 
+**signing_log** | [**SigningLog**](SigningLog.md) |  | [optional] 
+**security_hash** | **String** |  | [optional] 
+**attachments** | [**Array<DocumentAttachment>**](DocumentAttachment.md) |  | [optional] 
+**auto_delete_after** | **DateTime** |  | [optional] 
+
+

data/docs/DocumentAttachment.md

@@ -0,0 +1,15 @@
+# SignRequestClient::DocumentAttachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | [optional] 
+**uuid** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**file** | **String** |  | [optional] 
+**file_from_content** | **String** |  | [optional] 
+**file_from_content_name** | **String** |  | [optional] 
+**file_from_url** | **String** |  | [optional] 
+**document** | **String** |  | 
+
+