docs/DocumentsApi.md in signrequest_client-0.1.0 vs docs/DocumentsApi.md in signrequest_client-1.0.0
- old
+ new
@@ -2,24 +2,23 @@
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**](DocumentsApi.md#documents_create) | **POST** /documents/ | Create a Document
+[**documents_delete**](DocumentsApi.md#documents_delete) | **DELETE** /documents/{uuid}/ | Delete a Document
+[**documents_list**](DocumentsApi.md#documents_list) | **GET** /documents/ | Retrieve a list of Documents
+[**documents_read**](DocumentsApi.md#documents_read) | **GET** /documents/{uuid}/ | Retrieve a Document
# **documents_create**
> Document documents_create(data)
+Create a Document
-
### Example
```ruby
# load the gem
require 'signrequest_client'
# setup authorization
@@ -34,10 +33,11 @@
data = SignRequestClient::Document.new # Document |
begin
+ #Create a Document
result = api_instance.documents_create(data)
p result
rescue SignRequestClient::ApiError => e
puts "Exception when calling DocumentsApi->documents_create: #{e}"
end
@@ -65,14 +65,14 @@
# **documents_delete**
> documents_delete(uuid)
+Delete a Document
-
### Example
```ruby
# load the gem
require 'signrequest_client'
# setup authorization
@@ -87,10 +87,11 @@
uuid = "uuid_example" # String |
begin
+ #Delete a Document
api_instance.documents_delete(uuid)
rescue SignRequestClient::ApiError => e
puts "Exception when calling DocumentsApi->documents_delete: #{e}"
end
```
@@ -114,73 +115,17 @@
- **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)
+Retrieve a list of Documents
-
### Example
```ruby
# load the gem
require 'signrequest_client'
# setup authorization
@@ -206,10 +151,11 @@
page: 56, # Integer | A page number within the paginated result set.
limit: 56 # Integer | Number of results to return per page.
}
begin
+ #Retrieve a list of Documents
result = api_instance.documents_list(opts)
p result
rescue SignRequestClient::ApiError => e
puts "Exception when calling DocumentsApi->documents_list: #{e}"
end
@@ -247,14 +193,14 @@
# **documents_read**
> Document documents_read(uuid)
+Retrieve a Document
-
### Example
```ruby
# load the gem
require 'signrequest_client'
# setup authorization
@@ -269,9 +215,10 @@
uuid = "uuid_example" # String |
begin
+ #Retrieve a Document
result = api_instance.documents_read(uuid)
p result
rescue SignRequestClient::ApiError => e
puts "Exception when calling DocumentsApi->documents_read: #{e}"
end