Skip to content

Latest commit

 

History

History
147 lines (102 loc) · 3.89 KB

ConversionApi.md

File metadata and controls

147 lines (102 loc) · 3.89 KB

PDFGeneratorAPI::ConversionApi

All URIs are relative to https://us1.pdfgeneratorapi.com/api/v4

Method HTTP request Description
convert_html2_pdf POST /conversion/html2pdf HTML to PDF
convert_url2_pdf POST /conversion/url2pdf URL to PDF

convert_html2_pdf

convert_html2_pdf(convert_html2_pdf_request)

HTML to PDF

Converts HTML content to PDF

Examples

require 'time'
require 'pdf_generator_api_client'
# setup authorization
PDFGeneratorAPI.configure do |config|
  # Configure Bearer authorization (JWT): JSONWebTokenAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PDFGeneratorAPI::ConversionApi.new
convert_html2_pdf_request = PDFGeneratorAPI::ConvertHTML2PDFRequest.new # ConvertHTML2PDFRequest | 

begin
  # HTML to PDF
  result = api_instance.convert_html2_pdf(convert_html2_pdf_request)
  p result
rescue PDFGeneratorAPI::ApiError => e
  puts "Error when calling ConversionApi->convert_html2_pdf: #{e}"
end

Using the convert_html2_pdf_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> convert_html2_pdf_with_http_info(convert_html2_pdf_request)

begin
  # HTML to PDF
  data, status_code, headers = api_instance.convert_html2_pdf_with_http_info(convert_html2_pdf_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GenerateDocument201Response>
rescue PDFGeneratorAPI::ApiError => e
  puts "Error when calling ConversionApi->convert_html2_pdf_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
convert_html2_pdf_request ConvertHTML2PDFRequest

Return type

GenerateDocument201Response

Authorization

JSONWebTokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

convert_url2_pdf

convert_url2_pdf(convert_url2_pdf_request)

URL to PDF

Converts public URL to PDF

Examples

require 'time'
require 'pdf_generator_api_client'
# setup authorization
PDFGeneratorAPI.configure do |config|
  # Configure Bearer authorization (JWT): JSONWebTokenAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PDFGeneratorAPI::ConversionApi.new
convert_url2_pdf_request = PDFGeneratorAPI::ConvertURL2PDFRequest.new # ConvertURL2PDFRequest | 

begin
  # URL to PDF
  result = api_instance.convert_url2_pdf(convert_url2_pdf_request)
  p result
rescue PDFGeneratorAPI::ApiError => e
  puts "Error when calling ConversionApi->convert_url2_pdf: #{e}"
end

Using the convert_url2_pdf_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> convert_url2_pdf_with_http_info(convert_url2_pdf_request)

begin
  # URL to PDF
  data, status_code, headers = api_instance.convert_url2_pdf_with_http_info(convert_url2_pdf_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GenerateDocument201Response>
rescue PDFGeneratorAPI::ApiError => e
  puts "Error when calling ConversionApi->convert_url2_pdf_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
convert_url2_pdf_request ConvertURL2PDFRequest

Return type

GenerateDocument201Response

Authorization

JSONWebTokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json