docraptor 2.0.0 → 3.1.0

data/.review/generated_files/docs/DocApi.md

@@ -0,0 +1,503 @@
+# DocRaptor::DocApi
+
+All URIs are relative to *https://api.docraptor.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_async_doc**](DocApi.md#create_async_doc) | **POST** /async_docs |  |
+| [**create_doc**](DocApi.md#create_doc) | **POST** /docs |  |
+| [**create_hosted_async_doc**](DocApi.md#create_hosted_async_doc) | **POST** /hosted_async_docs |  |
+| [**create_hosted_doc**](DocApi.md#create_hosted_doc) | **POST** /hosted_docs |  |
+| [**expire**](DocApi.md#expire) | **PATCH** /expire/{id} |  |
+| [**get_async_doc**](DocApi.md#get_async_doc) | **GET** /download/{id} |  |
+| [**get_async_doc_status**](DocApi.md#get_async_doc_status) | **GET** /status/{id} |  |
+
+
+## create_async_doc
+
+> <AsyncDoc> create_async_doc(doc)
+
+
+
+Creates a document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | 
+
+begin
+  
+  result = api_instance.create_async_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_async_doc: #{e}"
+end
+```
+
+#### Using the create_async_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncDoc>, Integer, Hash)> create_async_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_async_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncDoc>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_async_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) |  |  |
+
+### Return type
+
+[**AsyncDoc**](AsyncDoc.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## create_doc
+
+> String create_doc(doc)
+
+
+
+Creates a document synchronously. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | 
+
+begin
+  
+  result = api_instance.create_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_doc: #{e}"
+end
+```
+
+#### Using the create_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> create_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## create_hosted_async_doc
+
+> <AsyncDoc> create_hosted_async_doc(doc)
+
+
+
+Creates a hosted document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | 
+
+begin
+  
+  result = api_instance.create_hosted_async_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_async_doc: #{e}"
+end
+```
+
+#### Using the create_hosted_async_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncDoc>, Integer, Hash)> create_hosted_async_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_hosted_async_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncDoc>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_async_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) |  |  |
+
+### Return type
+
+[**AsyncDoc**](AsyncDoc.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## create_hosted_doc
+
+> <DocStatus> create_hosted_doc(doc)
+
+
+
+Creates a hosted document synchronously. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+doc = DocRaptor::Doc.new({name: 'name_example', document_type: 'pdf'}) # Doc | The document to be created.
+
+begin
+  
+  result = api_instance.create_hosted_doc(doc)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_doc: #{e}"
+end
+```
+
+#### Using the create_hosted_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DocStatus>, Integer, Hash)> create_hosted_doc_with_http_info(doc)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_hosted_doc_with_http_info(doc)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DocStatus>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->create_hosted_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **doc** | [**Doc**](Doc.md) | The document to be created. |  |
+
+### Return type
+
+[**DocStatus**](DocStatus.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: */*
+
+
+## expire
+
+> expire(id)
+
+
+
+Expires a previously created hosted doc. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+id = 'id_example' # String | The download_id returned from status request or hosted document response.
+
+begin
+  
+  api_instance.expire(id)
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->expire: #{e}"
+end
+```
+
+#### Using the expire_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> expire_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.expire_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->expire_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The download_id returned from status request or hosted document response. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_async_doc
+
+> String get_async_doc(id)
+
+
+
+Downloads a finished document. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+id = 'id_example' # String | The download_id returned from an async status request or callback.
+
+begin
+  
+  result = api_instance.get_async_doc(id)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc: #{e}"
+end
+```
+
+#### Using the get_async_doc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_async_doc_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_async_doc_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The download_id returned from an async status request or callback. |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## get_async_doc_status
+
+> <DocStatus> get_async_doc_status(id)
+
+
+
+Check on the status of an asynchronously created document. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docraptor'
+# setup authorization
+DocRaptor.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocRaptor::DocApi.new
+id = 'id_example' # String | The status_id returned when creating an asynchronous document.
+
+begin
+  
+  result = api_instance.get_async_doc_status(id)
+  p result
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc_status: #{e}"
+end
+```
+
+#### Using the get_async_doc_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DocStatus>, Integer, Hash)> get_async_doc_status_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_async_doc_status_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DocStatus>
+rescue DocRaptor::ApiError => e
+  puts "Error when calling DocApi->get_async_doc_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The status_id returned when creating an asynchronous document. |  |
+
+### Return type
+
+[**DocStatus**](DocStatus.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+

data/.review/generated_files/docs/DocStatus.md

@@ -0,0 +1,28 @@
+# DocRaptor::DocStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The present status of the document. Can be queued, working, completed, and failed. | [optional] |
+| **download_url** | **String** | The URL where the document can be retrieved. This URL may only be used a few times. | [optional] |
+| **download_id** | **String** | The identifier for downloading the document with the download API. | [optional] |
+| **message** | **String** | Additional information. | [optional] |
+| **number_of_pages** | **Integer** | Number of PDF pages in document. | [optional] |
+| **validation_errors** | **String** | Error information. | [optional] |
+
+## Example
+
+```ruby
+require 'docraptor'
+
+instance = DocRaptor::DocStatus.new(
+  status: null,
+  download_url: null,
+  download_id: null,
+  message: null,
+  number_of_pages: null,
+  validation_errors: null
+)
+```
+

data/.review/generated_files/docs/PrinceOptions.md

@@ -0,0 +1,82 @@
+# DocRaptor::PrinceOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **baseurl** | **String** | Set the baseurl for assets. | [optional] |
+| **no_xinclude** | **Boolean** | Disable XML inclusion. | [optional] |
+| **no_network** | **Boolean** | Disable network access. | [optional] |
+| **no_parallel_downloads** | **Boolean** | Disables parallel fetching of assets during PDF creation. Useful if your asset host has strict rate limiting. | [optional] |
+| **http_user** | **String** | Set the user for HTTP authentication. | [optional] |
+| **http_password** | **String** | Set the password for HTTP authentication. | [optional] |
+| **http_proxy** | **String** | Set the HTTP proxy server. | [optional] |
+| **http_timeout** | **Integer** | Set the HTTP request timeout. | [optional] |
+| **insecure** | **Boolean** | Disable SSL verification. | [optional] |
+| **media** | **String** | Specify the CSS media type. Defaults to \"print\" but you may want to use \"screen\" for web styles. | [optional] |
+| **no_author_style** | **Boolean** | Ignore author stylesheets. | [optional] |
+| **no_default_style** | **Boolean** | Ignore default stylesheets. | [optional] |
+| **no_embed_fonts** | **Boolean** | Disable font embedding in PDFs. | [optional] |
+| **no_subset_fonts** | **Boolean** | Disable font subsetting in PDFs. | [optional] |
+| **no_compress** | **Boolean** | Disable PDF compression. | [optional] |
+| **encrypt** | **Boolean** | Encrypt PDF output. | [optional] |
+| **key_bits** | **Integer** | Set encryption key size. | [optional] |
+| **user_password** | **String** | Set the PDF user password. | [optional] |
+| **owner_password** | **String** | Set the PDF owner password. | [optional] |
+| **disallow_print** | **Boolean** | Disallow printing of this PDF. | [optional] |
+| **disallow_copy** | **Boolean** | Disallow copying of this PDF. | [optional] |
+| **disallow_annotate** | **Boolean** | Disallow annotation of this PDF. | [optional] |
+| **disallow_modify** | **Boolean** | Disallow modification of this PDF. | [optional] |
+| **debug** | **Boolean** | Enable Prince debug mode. | [optional] |
+| **input** | **String** | Specify the input format, defaults to html. | [optional] |
+| **version** | **String** | Deprecated, use the appropriate `pipeline` version. Specify a specific verison of PrinceXML to use. | [optional] |
+| **javascript** | **Boolean** | Enable PrinceXML JavaScript. DocRaptor JavaScript parsing is also available elsewhere. | [optional] |
+| **css_dpi** | **Integer** | Set the DPI when rendering CSS. Defaults to 96 but can be set with Prince 9.0 and up. | [optional] |
+| **profile** | **String** | In Prince 9.0 and up you can set the PDF profile. | [optional] |
+| **pdf_title** | **String** | Specify the PDF title, part of the document's metadata. | [optional] |
+| **iframes** | **Boolean** | Enable loading of iframes. | [optional] |
+| **page_margin** | **String** | Specify the page margin distance. | [optional] |
+| **pdf_forms** | **Boolean** | Make form fields editable by default. | [optional] |
+
+## Example
+
+```ruby
+require 'docraptor'
+
+instance = DocRaptor::PrinceOptions.new(
+  baseurl: null,
+  no_xinclude: null,
+  no_network: null,
+  no_parallel_downloads: null,
+  http_user: null,
+  http_password: null,
+  http_proxy: null,
+  http_timeout: null,
+  insecure: null,
+  media: null,
+  no_author_style: null,
+  no_default_style: null,
+  no_embed_fonts: null,
+  no_subset_fonts: null,
+  no_compress: null,
+  encrypt: null,
+  key_bits: null,
+  user_password: null,
+  owner_password: null,
+  disallow_print: null,
+  disallow_copy: null,
+  disallow_annotate: null,
+  disallow_modify: null,
+  debug: null,
+  input: null,
+  version: null,
+  javascript: null,
+  css_dpi: null,
+  profile: null,
+  pdf_title: null,
+  iframes: null,
+  page_margin: null,
+  pdf_forms: null
+)
+```
+