signrequest_client 0.1.0

data/docs/DocumentAttachmentsApi.md

@@ -0,0 +1,179 @@
+# SignRequestClient::DocumentAttachmentsApi
+
+All URIs are relative to *https://signrequest.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**document_attachments_create**](DocumentAttachmentsApi.md#document_attachments_create) | **POST** /document-attachments/ | 
+[**document_attachments_list**](DocumentAttachmentsApi.md#document_attachments_list) | **GET** /document-attachments/ | 
+[**document_attachments_read**](DocumentAttachmentsApi.md#document_attachments_read) | **GET** /document-attachments/{uuid}/ | 
+
+
+# **document_attachments_create**
+> DocumentAttachment document_attachments_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::DocumentAttachmentsApi.new
+
+data = SignRequestClient::DocumentAttachment.new # DocumentAttachment | 
+
+
+begin
+  result = api_instance.document_attachments_create(data)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentAttachmentsApi->document_attachments_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**DocumentAttachment**](DocumentAttachment.md)|  | 
+
+### Return type
+
+[**DocumentAttachment**](DocumentAttachment.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **document_attachments_list**
+> InlineResponse2001 document_attachments_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::DocumentAttachmentsApi.new
+
+opts = { 
+  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.
+}
+
+begin
+  result = api_instance.document_attachments_list(opts)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentAttachmentsApi->document_attachments_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **document__uuid** | **String**|  | [optional] 
+ **document__external_id** | **String**|  | [optional] 
+ **created** | **String**|  | [optional] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **document_attachments_read**
+> DocumentAttachment document_attachments_read(uuid)
+
+
+
+
+
+### 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::DocumentAttachmentsApi.new
+
+uuid = "uuid_example" # String | 
+
+
+begin
+  result = api_instance.document_attachments_read(uuid)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentAttachmentsApi->document_attachments_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+
+### Return type
+
+[**DocumentAttachment**](DocumentAttachment.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DocumentSearch.md

@@ -0,0 +1,22 @@
+# SignRequestClient::DocumentSearch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**who** | **String** |  | 
+**nr_extra_docs** | **Integer** |  | 
+**from_email** | **String** |  | 
+**parent_doc** | **String** |  | 
+**uuid** | **String** |  | [optional] 
+**created** | **DateTime** |  | [optional] 
+**autocomplete** | **String** |  | 
+**finished_on** | **DateTime** |  | 
+**subdomain** | **String** |  | 
+**signer_emails** | **Array<String>** |  | [optional] 
+**status_display** | **String** |  | [optional] 
+**created_timestamp** | **Integer** |  | [optional] 
+**finished_on_timestamp** | **Integer** |  | [optional] 
+
+

data/docs/DocumentSignerTemplateConf.md

@@ -0,0 +1,14 @@
+# SignRequestClient::DocumentSignerTemplateConf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signer_index** | **Integer** |  | [optional] 
+**needs_to_sign** | **BOOLEAN** |  | [optional] 
+**approve_only** | **BOOLEAN** |  | [optional] 
+**notify_only** | **BOOLEAN** |  | [optional] 
+**in_person** | **BOOLEAN** |  | [optional] 
+**order** | **Integer** |  | [optional] 
+**placeholders** | [**Array<Placeholder>**](Placeholder.md) |  | [optional] 
+
+

data/docs/DocumentsApi.md

@@ -0,0 +1,301 @@
+# SignRequestClient::DocumentsApi
+
+All URIs are relative to *https://signrequest.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**documents_create**](DocumentsApi.md#documents_create) | **POST** /documents/ | 
+[**documents_delete**](DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ | 
+[**documents_delete_files**](DocumentsApi.md#documents_delete_files) | **POST** /documents/{uuid}/delete_files/ | 
+[**documents_list**](DocumentsApi.md#documents_list) | **GET** /documents/ | 
+[**documents_read**](DocumentsApi.md#documents_read) | **GET** /documents/{uuid}/ | 
+
+
+# **documents_create**
+> Document documents_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::DocumentsApi.new
+
+data = SignRequestClient::Document.new # Document | 
+
+
+begin
+  result = api_instance.documents_create(data)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentsApi->documents_create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**Document**](Document.md)|  | 
+
+### Return type
+
+[**Document**](Document.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **documents_delete**
+> documents_delete(uuid)
+
+
+
+
+
+### 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::DocumentsApi.new
+
+uuid = "uuid_example" # String | 
+
+
+begin
+  api_instance.documents_delete(uuid)
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentsApi->documents_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **documents_delete_files**
+> Document documents_delete_files(uuid, data)
+
+
+
+This is only for integration partners
+
+### 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::DocumentsApi.new
+
+uuid = "uuid_example" # String | 
+
+data = SignRequestClient::Document.new # Document | 
+
+
+begin
+  result = api_instance.documents_delete_files(uuid, data)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentsApi->documents_delete_files: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+ **data** | [**Document**](Document.md)|  | 
+
+### Return type
+
+[**Document**](Document.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **documents_list**
+> InlineResponse2003 documents_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::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 | 
+  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.documents_list(opts)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentsApi->documents_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **external_id** | **String**|  | [optional] 
+ **signrequest__who** | **String**|  | [optional] 
+ **signrequest__from_email** | **String**|  | [optional] 
+ **status** | **String**|  | [optional] 
+ **user__email** | **String**|  | [optional] 
+ **user__first_name** | **String**|  | [optional] 
+ **user__last_name** | **String**|  | [optional] 
+ **created** | **String**|  | [optional] 
+ **modified** | **String**|  | [optional] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **documents_read**
+> Document documents_read(uuid)
+
+
+
+
+
+### 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::DocumentsApi.new
+
+uuid = "uuid_example" # String | 
+
+
+begin
+  result = api_instance.documents_read(uuid)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentsApi->documents_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+
+### Return type
+
+[**Document**](Document.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DocumentsSearchApi.md

@@ -0,0 +1,119 @@
+# SignRequestClient::DocumentsSearchApi
+
+All URIs are relative to *https://signrequest.com/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**documents_search_list**](DocumentsSearchApi.md#documents_search_list) | **GET** /documents-search/ | 
+[**documents_search_read**](DocumentsSearchApi.md#documents_search_read) | **GET** /documents-search/{id}/ | 
+
+
+# **documents_search_list**
+> InlineResponse2002 documents_search_list(opts)
+
+
+
+## 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.
+
+### 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::DocumentsSearchApi.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.documents_search_list(opts)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentsSearchApi->documents_search_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
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/csv, application/vnd.ms-excel
+
+
+
+# **documents_search_read**
+> DocumentSearch documents_search_read(id)
+
+
+
+## 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.
+
+### 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::DocumentsSearchApi.new
+
+id = "id_example" # String | 
+
+
+begin
+  result = api_instance.documents_search_read(id)
+  p result
+rescue SignRequestClient::ApiError => e
+  puts "Exception when calling DocumentsSearchApi->documents_search_read: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**DocumentSearch**](DocumentSearch.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/csv, application/vnd.ms-excel
+
+
+

data/docs/Event.md

@@ -0,0 +1,17 @@
+# SignRequestClient::Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**event_type** | **String** |  | [optional] 
+**delivered** | **BOOLEAN** |  | [optional] 
+**delivered_on** | **DateTime** |  | [optional] 
+**callback_status_code** | **Integer** |  | [optional] 
+**timestamp** | **DateTime** |  | [optional] 
+**team** | [**InlineTeam**](InlineTeam.md) |  | [optional] 
+**document** | [**Document**](Document.md) |  | [optional] 
+**signer** | [**Signer**](Signer.md) |  | [optional] 
+
+