Skip to content

Orpalis/passportpdfsdk-ruby

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

openapi_client

OpenapiClient - the Ruby gem for the PassportPDF API

Another brick in the cloud

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'openapi_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'openapi_client'

api_instance = OpenapiClient::ConfigApi.new

begin
  result = api_instance.config_get_api_version
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ConfigApi->config_get_api_version: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://passportpdfapi.com

Class Method HTTP request Description
OpenapiClient::ConfigApi config_get_api_version GET /api/config/ConfigGetAPIVersion
OpenapiClient::ConfigApi config_get_max_allowed_content_length GET /api/config/ConfigGetMaxAllowedContentLength Gets the maximal length of a request content, in bytes.
OpenapiClient::ConfigApi config_get_suggested_client_timeout GET /api/config/ConfigGetSuggestedClientTimeout Gets the suggested client API timeout, in milliseconds.
OpenapiClient::ConfigApi config_get_suggested_max_client_threads GET /api/config/ConfigGetSuggestedMaxClientThreads Gets the suggested maximum number of threads to be used simultaneously by a client application.
OpenapiClient::ConfigApi config_get_supported_fonts GET /api/config/ConfigGetSupportedFonts Gets the list of supported fonts for text drawing operations.
OpenapiClient::ConfigApi config_get_supported_ocr_languages GET /api/config/ConfigGetSupportedOCRLanguages Gets the list of supported languages for OCR.
OpenapiClient::DocuViewareApi docu_vieware_get_control POST /api/docuvieware/DocuViewareGetControl Gets the HTML dom of a DocuVieware control.
OpenapiClient::DocuViewareApi docu_vieware_get_version GET /api/docuvieware/DocuViewareGetVersion Get the DocuVieware engine version.
OpenapiClient::DocuViewareApi docu_vieware_save POST /api/docuvieware/DocuViewareSave Saves the document being handled by a specific DocuVieware control, in its current state.
OpenapiClient::DocumentApi document_close POST /api/document/DocumentClose Closes a previously uploaded document.
OpenapiClient::DocumentApi document_get_preview POST /api/document/DocumentGetPreview Gets the format, the page count and a thumbnail of a previously uploaded document.
OpenapiClient::DocumentApi document_load POST /api/document/DocumentLoad Loads the provided document file.
OpenapiClient::DocumentApi document_load_from_uri POST /api/document/DocumentLoadFromURI Loads the provided document file from an URI.
OpenapiClient::DocumentApi document_load_multipart POST /api/document/DocumentLoadMultipart Loads the provided document file using Multipart Upload.
OpenapiClient::ImageApi image_adjust POST /api/image/ImageAdjust Adjusts a previously uploaded image.
OpenapiClient::ImageApi image_auto_crop POST /api/image/ImageAutoCrop Automatically crops a previously uploaded image.
OpenapiClient::ImageApi image_cleanup_document POST /api/image/ImageCleanupDocument Cleanup a previously uploaded image.
OpenapiClient::ImageApi image_clone_regions POST /api/image/ImageCloneRegions Clones regions from a previously uploaded image into new images.
OpenapiClient::ImageApi image_close POST /api/image/ImageClose Closes a previously uploaded image.
OpenapiClient::ImageApi image_convert_color_depth POST /api/image/ImageConvertColorDepth Converts the color depth of a previously uploaded image.
OpenapiClient::ImageApi image_crop POST /api/image/ImageCrop Crops a previously uploaded image.
OpenapiClient::ImageApi image_delete_page POST /api/image/ImageDeletePage Deletes a page range from a previously uploaded image.
OpenapiClient::ImageApi image_detect_blank_pages POST /api/image/ImageDetectBlankPages Detects the blank page(s) from a previously uploaded image and offers to remove them.
OpenapiClient::ImageApi image_detect_color POST /api/image/ImageDetectColor Performs color detection on a previously uploaded image.
OpenapiClient::ImageApi image_detect_page_orientation POST /api/image/ImageDetectPageOrientation Detects the orientation of the page(s) of a previously uploaded image and offers to automatically rotate them.
OpenapiClient::ImageApi image_filter POST /api/image/ImageFilter Applies filters to a previously uploaded image.
OpenapiClient::ImageApi image_get_page_thumbnail POST /api/image/ImageGetPageThumbnail Gets a thumbnail of each page within the provided page range from a previously uploaded image.
OpenapiClient::ImageApi image_get_supported_file_extensions GET /api/image/ImageGetSupportedFileExtensions Gets the supported file extensions by the image loading actions.
OpenapiClient::ImageApi image_load POST /api/image/ImageLoad Loads the provided image file. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.
OpenapiClient::ImageApi image_load_multipart POST /api/image/ImageLoadMultipart Loads the provided image file using Multipart Upload. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.
OpenapiClient::ImageApi image_micr POST /api/image/ImageMICR Performs MICR (Magnetic Ink Character Recognition) on a previously uploaded image.
OpenapiClient::ImageApi image_read_barcodes POST /api/image/ImageReadBarcodes Reads barcodes from a previously uploaded image.
OpenapiClient::ImageApi image_resize POST /api/image/ImageResize Resizes a previously uploaded image.
OpenapiClient::ImageApi image_rotate POST /api/image/ImageRotate Rotates and/or flips a previously uploaded image.
OpenapiClient::ImageApi image_save_as_jpeg POST /api/image/ImageSaveAsJPEG Saves a previously uploaded image as JPEG, and sends the file data in a JSON-serialized object.
OpenapiClient::ImageApi image_save_as_jpeg_file POST /api/image/ImageSaveAsJPEGFile Saves a previously uploaded image as JPEG, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::ImageApi image_save_as_pdf POST /api/image/ImageSaveAsPDF Saves a previously uploaded image as PDF, and sends the file data in a JSON-serialized object.
OpenapiClient::ImageApi image_save_as_pdf_file POST /api/image/ImageSaveAsPDFFile Saves a previously uploaded image as PDF, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::ImageApi image_save_as_pdfmrc POST /api/image/ImageSaveAsPDFMRC Saves a previously uploaded image as PDF using MRC compression, and sends the file data in a JSON-serialized object.
OpenapiClient::ImageApi image_save_as_pdfmrc_file POST /api/image/ImageSaveAsPDFMRCFile Saves a previously uploaded image as PDF using MRC compression, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::ImageApi image_save_as_png POST /api/image/ImageSaveAsPNG Saves a previously uploaded image as PNG, and sends the file data in a JSON-serialized object.
OpenapiClient::ImageApi image_save_as_png_file POST /api/image/ImageSaveAsPNGFile Saves a previously uploaded image as PNG, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::ImageApi image_save_as_tiff POST /api/image/ImageSaveAsTIFF Saves a previously uploaded image as TIFF, and sends the file data in a JSON-serialized object.
OpenapiClient::ImageApi image_save_as_tiff_file POST /api/image/ImageSaveAsTIFFFile Saves a previously uploaded image as TIFF, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::ImageApi image_save_as_tiff_multipage POST /api/image/ImageSaveAsTIFFMultipage Saves a previously uploaded image as multipage TIFF, and sends the file data in a JSON-serialized object.
OpenapiClient::ImageApi image_save_as_tiff_multipage_file POST /api/image/ImageSaveAsTIFFMultipageFile Saves a previously uploaded image as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::ImageApi image_swap_pages POST /api/image/ImageSwapPages Swaps two pages from a previously uploaded image.
OpenapiClient::PDFApi annotate POST /api/pdf/Annotate Annotates a previously uploaded document.
OpenapiClient::PDFApi auto_deskew POST /api/pdf/AutoDeskew Performs auto deskew on a page range of a previously uploaded document.
OpenapiClient::PDFApi clear_page POST /api/pdf/ClearPage Clears a page range from a previously uploaded document.
OpenapiClient::PDFApi clone_page POST /api/pdf/ClonePage Clones specific pages from a previously uploaded document to another previously uploaded document.
OpenapiClient::PDFApi close_pdf POST /api/pdf/ClosePDF Closes a previously uploaded document.
OpenapiClient::PDFApi convert_to_pdfa POST /api/pdf/ConvertToPDFA Converts a previously uploaded document to PDF/A.
OpenapiClient::PDFApi delete_page POST /api/pdf/DeletePage Deletes a page range from a previously uploaded document.
OpenapiClient::PDFApi detect_page_orientation POST /api/pdf/DetectPageOrientation Detects the orientation of the page(s) of a previously uploaded document and offers to automatically rotate them.
OpenapiClient::PDFApi digi_sign POST /api/pdf/DigiSign Signs a previously uploaded document digitally.
OpenapiClient::PDFApi draw_image POST /api/pdf/DrawImage Draws an image on a page range of a previously uploaded document.
OpenapiClient::PDFApi extract_page POST /api/pdf/ExtractPage Extracts a page range from a previously uploaded document into one or several new documents.
OpenapiClient::PDFApi extract_text POST /api/pdf/ExtractText Extracts text from the document pages.
OpenapiClient::PDFApi flatten POST /api/pdf/Flatten Flattens the form-fields, annotations, and/or the layers of a previously uploaded document.
OpenapiClient::PDFApi get_info POST /api/pdf/GetInfo Gets information about a previously uploaded document.
OpenapiClient::PDFApi get_page_thumbnail POST /api/pdf/GetPageThumbnail Gets a thumbnail of each page within the provided page range from a previously uploaded document.
OpenapiClient::PDFApi get_pdf_import_supported_file_extensions GET /api/pdf/GetPDFImportSupportedFileExtensions Gets the supported file extensions by the LoadDocumentAsPDF action.
OpenapiClient::PDFApi insert_image POST /api/pdf/InsertImage Inserts an image on a new page of a previously uploaded document.
OpenapiClient::PDFApi insert_new_page POST /api/pdf/InsertNewPage Inserts one or more new blank pages to a specific position in a previously uploaded document.
OpenapiClient::PDFApi insert_page_number POST /api/pdf/InsertPageNumber Inserts page number(s) on a document.
OpenapiClient::PDFApi insert_text POST /api/pdf/InsertText Inserts text on a document.
OpenapiClient::PDFApi linearize POST /api/pdf/Linearize Linearizes a previously uploaded document.
OpenapiClient::PDFApi load_document_as_pdf POST /api/pdf/LoadDocument Imports the provided document as PDF. Supported document formats can be retrieved by the GetPDFImportSupportedFileExtensions action.
OpenapiClient::PDFApi load_document_as_pdf_multipart POST /api/pdf/LoadDocumentAsPDFMultipart Imports the provided document as PDF using Multipart Upload. Supported document formats can be retrieved by the GetPDFImportSupportedFileExtensions action.
OpenapiClient::PDFApi merge POST /api/pdf/Merge Merges several previously uploaded documents into a new PDF.
OpenapiClient::PDFApi merge_pages POST /api/pdf/MergePages Merges multiple pages, vertically, within a previously uploaded document into one single page.
OpenapiClient::PDFApi move_page POST /api/pdf/MovePage Moves a page range from a previously uploaded document.
OpenapiClient::PDFApi o_cr POST /api/pdf/OCR Performs optical character recognition on a page range of a previously uploaded document. The recognized text is added as invisible text on each processed page. No token is charged for blank pages.
OpenapiClient::PDFApi protect POST /api/pdf/Protect Protects a previously uploaded document.
OpenapiClient::PDFApi read_barcodes POST /api/pdf/ReadBarcodes Reads barcodes from a previously uploaded document.
OpenapiClient::PDFApi reduce POST /api/pdf/Reduce Reduces the size of a previously uploaded document.
OpenapiClient::PDFApi remove_page_form_fields POST /api/pdf/RemovePageFormFields Removes the form fields from a page range of a previously uploaded document.
OpenapiClient::PDFApi remove_text POST /api/pdf/RemoveText Removes text (all text or only invisible one) from a previously uploaded PDF.
OpenapiClient::PDFApi reorder_pages POST /api/pdf/ReorderPages Reorders pages of a previously uploaded document.
OpenapiClient::PDFApi repair_document POST /api/pdf/RepairDocument Repairs a previously uploaded PDF document.
OpenapiClient::PDFApi rotate_page_standard POST /api/pdf/RotatePageStandard Rotates (standardly) a page range from a previously uploaded document.
OpenapiClient::PDFApi save_as_jpeg POST /api/pdf/SaveAsJPEG Saves a previously uploaded document as JPEG, and sends the file data in a JSON-serialized object.
OpenapiClient::PDFApi save_as_jpeg_file POST /api/pdf/SaveAsJPEGFile Saves a previously uploaded document as JPEG, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::PDFApi save_as_png POST /api/pdf/SaveAsPNG Saves a previously uploaded document as PNG, and sends the file data in a JSON-serialized object.
OpenapiClient::PDFApi save_as_png_file POST /api/pdf/SaveAsPNGFile Saves a previously uploaded document as PNG, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::PDFApi save_as_tiff POST /api/pdf/SaveAsTIFF Saves a previously uploaded document as TIFF, and sends the file data in a JSON-serialized object.
OpenapiClient::PDFApi save_as_tiff_file POST /api/pdf/SaveAsTIFFFile Saves a previously uploaded document as TIFF, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::PDFApi save_as_tiff_multipage POST /api/pdf/SaveAsTIFFMultipage Saves a previously uploaded document as multipage TIFF, and sends the file data in a JSON-serialized object.
OpenapiClient::PDFApi save_as_tiff_multipage_file POST /api/pdf/SaveAsTIFFMultipageFile Saves a previously uploaded document as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::PDFApi save_document POST /api/pdf/SaveDocument Saves a previously uploaded document as PDF, and sends the file data in a JSON-serialized object.
OpenapiClient::PDFApi save_document_to_file POST /api/pdf/SaveDocumentToFile Saves a previously uploaded document as PDF, and streams the file binary data to the response (this is the most efficient download method).
OpenapiClient::PDFApi scale_page POST /api/pdf/ScalePage Scales a page range from a previously uploaded document.
OpenapiClient::PDFApi set_info POST /api/pdf/SetInfo Sets information to a previously uploaded document.
OpenapiClient::PDFApi set_initial_view POST /api/pdf/SetInitialView Sets various document level initial view options to a previously uploaded document.
OpenapiClient::PDFApi set_page_box POST /api/pdf/SetPageBox Sets pagebox to a page range from previously uploaded document.
OpenapiClient::PDFApi set_password POST /api/pdf/SetPassword Unprotects a previously uploaded document.
OpenapiClient::PDFApi split POST /api/pdf/Split Splits a previously uploaded document into new ones.
OpenapiClient::PDFApi swap_pages POST /api/pdf/SwapPages Swaps two pages from a previously uploaded document.
OpenapiClient::PDFApi unprotect POST /api/pdf/Unprotect Unprotects a previously uploaded document.
OpenapiClient::PassportManagerApi passport_manager_get_passport_info GET /api/passportmanager/PassportManagerGetPassportInfo
OpenapiClient::PassportPDFApplicationManagerApi passport_pdf_application_manager_get_application_download_link GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetApplicationDownloadLink
OpenapiClient::PassportPDFApplicationManagerApi passport_pdf_application_manager_get_application_latest_version GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetApplicationLatestVersion
OpenapiClient::PassportPDFApplicationManagerApi passport_pdf_application_manager_get_application_minimum_supported_version GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetApplicationMinimumSupportedVersion
OpenapiClient::PassportPDFApplicationManagerApi passport_pdf_application_manager_get_max_client_threads GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetMaxClientThreads Gets the maximum number of threads to be used simultaneously by a client application.

Documentation for Models

Documentation for Authorization

PassportPDFAuthentication

  • Type: API key
  • API key parameter name: X-PassportPDF-API-Key
  • Location: HTTP header

About

ORPALIS PassportPDF API Client SDK

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published