OpenapiClient::ImageApi

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

Method	HTTP request	Description
image_adjust	POST /api/image/ImageAdjust	Adjusts a previously uploaded image.
image_auto_crop	POST /api/image/ImageAutoCrop	Automatically crops a previously uploaded image.
image_cleanup_document	POST /api/image/ImageCleanupDocument	Cleanup a previously uploaded image.
image_clone_regions	POST /api/image/ImageCloneRegions	Clones regions from a previously uploaded image into new images.
image_close	POST /api/image/ImageClose	Closes a previously uploaded image.
image_convert_color_depth	POST /api/image/ImageConvertColorDepth	Converts the color depth of a previously uploaded image.
image_crop	POST /api/image/ImageCrop	Crops a previously uploaded image.
image_delete_page	POST /api/image/ImageDeletePage	Deletes a page range from a previously uploaded image.
image_detect_blank_pages	POST /api/image/ImageDetectBlankPages	Detects the blank page(s) from a previously uploaded image and offers to remove them.
image_detect_color	POST /api/image/ImageDetectColor	Performs color detection on a previously uploaded image.
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.
image_filter	POST /api/image/ImageFilter	Applies filters to a previously uploaded image.
image_get_page_thumbnail	POST /api/image/ImageGetPageThumbnail	Gets a thumbnail of each page within the provided page range from a previously uploaded image.
image_get_supported_file_extensions	GET /api/image/ImageGetSupportedFileExtensions	Gets the supported file extensions by the image loading actions.
image_load	POST /api/image/ImageLoad	Loads the provided image file. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.
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.
image_micr	POST /api/image/ImageMICR	Performs MICR (Magnetic Ink Character Recognition) on a previously uploaded image.
image_read_barcodes	POST /api/image/ImageReadBarcodes	Reads barcodes from a previously uploaded image.
image_resize	POST /api/image/ImageResize	Resizes a previously uploaded image.
image_rotate	POST /api/image/ImageRotate	Rotates and/or flips a previously uploaded image.
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.
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).
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.
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).
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.
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).
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.
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).
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.
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).
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.
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).
image_swap_pages	POST /api/image/ImageSwapPages	Swaps two pages from a previously uploaded image.

image_adjust

ImageAdjustResponse image_adjust(image_adjust_parameters)

Adjusts a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_adjust_parameters = OpenapiClient::ImageAdjustParameters.new # ImageAdjustParameters | An ImageAdjustParameters object specifying the parameters for the action.

begin
  #Adjusts a previously uploaded image.
  result = api_instance.image_adjust(image_adjust_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_adjust: #{e}"
end

Parameters

Name	Type	Description	Notes
image_adjust_parameters	ImageAdjustParameters	An ImageAdjustParameters object specifying the parameters for the action.

Return type

ImageAdjustResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_auto_crop

ImageAutoCropResponse image_auto_crop(image_auto_crop_parameters)

Automatically crops a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_auto_crop_parameters = OpenapiClient::ImageAutoCropParameters.new # ImageAutoCropParameters | An ImageAutoCropParameters object specifying the parameters for the action.

begin
  #Automatically crops a previously uploaded image.
  result = api_instance.image_auto_crop(image_auto_crop_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_auto_crop: #{e}"
end

Parameters

Name	Type	Description	Notes
image_auto_crop_parameters	ImageAutoCropParameters	An ImageAutoCropParameters object specifying the parameters for the action.

Return type

ImageAutoCropResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_cleanup_document

ImageCleanupDocumentResponse image_cleanup_document(image_cleanup_document_parameters)

Cleanup a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_cleanup_document_parameters = OpenapiClient::ImageCleanupDocumentParameters.new # ImageCleanupDocumentParameters | An ImageCleanupDocumentParameters object specifying the parameters for the action.

begin
  #Cleanup a previously uploaded image.
  result = api_instance.image_cleanup_document(image_cleanup_document_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_cleanup_document: #{e}"
end

Parameters

Name	Type	Description	Notes
image_cleanup_document_parameters	ImageCleanupDocumentParameters	An ImageCleanupDocumentParameters object specifying the parameters for the action.

Return type

ImageCleanupDocumentResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_clone_regions

ImageCloneRegionsResponse image_clone_regions(image_clone_regions_parameters)

Clones regions from a previously uploaded image into new images.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_clone_regions_parameters = OpenapiClient::ImageCloneRegionsParameters.new # ImageCloneRegionsParameters | An ImageCloneRegionsParameters object specifying the parameters of the action.

begin
  #Clones regions from a previously uploaded image into new images.
  result = api_instance.image_clone_regions(image_clone_regions_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_clone_regions: #{e}"
end

Parameters

Name	Type	Description	Notes
image_clone_regions_parameters	ImageCloneRegionsParameters	An ImageCloneRegionsParameters object specifying the parameters of the action.

Return type

ImageCloneRegionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_close

ImageCloseResponse image_close(image_close_parameters)

Closes a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_close_parameters = OpenapiClient::ImageCloseParameters.new # ImageCloseParameters | An ImageCloseParameters object specifying the parameters of the action.

begin
  #Closes a previously uploaded image.
  result = api_instance.image_close(image_close_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_close: #{e}"
end

Parameters

Name	Type	Description	Notes
image_close_parameters	ImageCloseParameters	An ImageCloseParameters object specifying the parameters of the action.

Return type

ImageCloseResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_convert_color_depth

ImageConvertColorDepthResponse image_convert_color_depth(image_convert_color_depth_parameters)

Converts the color depth of a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_convert_color_depth_parameters = OpenapiClient::ImageConvertColorDepthParameters.new # ImageConvertColorDepthParameters | An ImageConvertColorDepthParameters object specifying the parameters for the action.

begin
  #Converts the color depth of a previously uploaded image.
  result = api_instance.image_convert_color_depth(image_convert_color_depth_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_convert_color_depth: #{e}"
end

Parameters

Name	Type	Description	Notes
image_convert_color_depth_parameters	ImageConvertColorDepthParameters	An ImageConvertColorDepthParameters object specifying the parameters for the action.

Return type

ImageConvertColorDepthResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_crop

ImageCropResponse image_crop(image_crop_parameters)

Crops a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_crop_parameters = OpenapiClient::ImageCropParameters.new # ImageCropParameters | An ImageCropParameters object specifying the parameters for the action.

begin
  #Crops a previously uploaded image.
  result = api_instance.image_crop(image_crop_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_crop: #{e}"
end

Parameters

Name	Type	Description	Notes
image_crop_parameters	ImageCropParameters	An ImageCropParameters object specifying the parameters for the action.

Return type

ImageCropResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_delete_page

ImageDeletePageResponse image_delete_page(image_delete_page_parameters)

Deletes a page range from a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_delete_page_parameters = OpenapiClient::ImageDeletePageParameters.new # ImageDeletePageParameters | An ImageDeletePageParameters object specifying the parameters of the action.

begin
  #Deletes a page range from a previously uploaded image.
  result = api_instance.image_delete_page(image_delete_page_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_delete_page: #{e}"
end

Parameters

Name	Type	Description	Notes
image_delete_page_parameters	ImageDeletePageParameters	An ImageDeletePageParameters object specifying the parameters of the action.

Return type

ImageDeletePageResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_detect_blank_pages

ImageDetectBlankPagesResponse image_detect_blank_pages(image_detect_blank_pages_parameters)

Detects the blank page(s) from a previously uploaded image and offers to remove them.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_detect_blank_pages_parameters = OpenapiClient::ImageDetectBlankPagesParameters.new # ImageDetectBlankPagesParameters | An ImageDetectBlankPagesParameters object specifying the parameters of the action.

begin
  #Detects the blank page(s) from a previously uploaded image and offers to remove them.
  result = api_instance.image_detect_blank_pages(image_detect_blank_pages_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_detect_blank_pages: #{e}"
end

Parameters

Name	Type	Description	Notes
image_detect_blank_pages_parameters	ImageDetectBlankPagesParameters	An ImageDetectBlankPagesParameters object specifying the parameters of the action.

Return type

ImageDetectBlankPagesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_detect_color

ImageDetectColorResponse image_detect_color(image_detect_color_parameters)

Performs color detection on a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_detect_color_parameters = OpenapiClient::ImageDetectColorParameters.new # ImageDetectColorParameters | An ImageDetectColorParameters object specifying the parameters for the action.

begin
  #Performs color detection  on a previously uploaded image.
  result = api_instance.image_detect_color(image_detect_color_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_detect_color: #{e}"
end

Parameters

Name	Type	Description	Notes
image_detect_color_parameters	ImageDetectColorParameters	An ImageDetectColorParameters object specifying the parameters for the action.

Return type

ImageDetectColorResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_detect_page_orientation

ImageDetectPageOrientationResponse image_detect_page_orientation(image_detect_page_orientation_parameters)

Detects the orientation of the page(s) of a previously uploaded image and offers to automatically rotate them.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_detect_page_orientation_parameters = OpenapiClient::ImageDetectPageOrientationParameters.new # ImageDetectPageOrientationParameters | An ImagedetectPageOrientationParameters object specifying the parameters of the action.

begin
  #Detects the orientation of the page(s) of a previously uploaded image and offers to automatically rotate them.
  result = api_instance.image_detect_page_orientation(image_detect_page_orientation_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_detect_page_orientation: #{e}"
end

Parameters

Name	Type	Description	Notes
image_detect_page_orientation_parameters	ImageDetectPageOrientationParameters	An ImagedetectPageOrientationParameters object specifying the parameters of the action.

Return type

ImageDetectPageOrientationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_filter

ImageFilterResponse image_filter(image_filter_parameters)

Applies filters to a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_filter_parameters = OpenapiClient::ImageFilterParameters.new # ImageFilterParameters | An ImageFilterParameters object specifying the parameters for the action.

begin
  #Applies filters to a previously uploaded image.
  result = api_instance.image_filter(image_filter_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_filter: #{e}"
end

Parameters

Name	Type	Description	Notes
image_filter_parameters	ImageFilterParameters	An ImageFilterParameters object specifying the parameters for the action.

Return type

ImageFilterResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_get_page_thumbnail

ImageGetPageThumbnailResponse image_get_page_thumbnail(image_get_page_thumbnail_parameters)

Gets a thumbnail of each page within the provided page range from a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_get_page_thumbnail_parameters = OpenapiClient::ImageGetPageThumbnailParameters.new # ImageGetPageThumbnailParameters | A PDFGetPageThumbnailParameters object specifying the parameters of the action.

begin
  #Gets a thumbnail of each page within the provided page range from a previously uploaded image.
  result = api_instance.image_get_page_thumbnail(image_get_page_thumbnail_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_get_page_thumbnail: #{e}"
end

Parameters

Name	Type	Description	Notes
image_get_page_thumbnail_parameters	ImageGetPageThumbnailParameters	A PDFGetPageThumbnailParameters object specifying the parameters of the action.

Return type

ImageGetPageThumbnailResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_get_supported_file_extensions

StringArrayResponse image_get_supported_file_extensions

Gets the supported file extensions by the image loading actions.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new

begin
  #Gets the supported file extensions by the image loading actions.
  result = api_instance.image_get_supported_file_extensions
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_get_supported_file_extensions: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

StringArrayResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

image_load

ImageLoadResponse image_load(load_image_from_byte_array_parameters)

Loads the provided image file. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
load_image_from_byte_array_parameters = OpenapiClient::LoadImageFromByteArrayParameters.new # LoadImageFromByteArrayParameters | A LoadImageFromByteArrayParameters object specifying the parameters of the action.

begin
  #Loads the provided image file.  Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.
  result = api_instance.image_load(load_image_from_byte_array_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_load: #{e}"
end

Parameters

Name	Type	Description	Notes
load_image_from_byte_array_parameters	LoadImageFromByteArrayParameters	A LoadImageFromByteArrayParameters object specifying the parameters of the action.

Return type

ImageLoadResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_load_multipart

ImageLoadResponse image_load_multipart(file_data, opts)

Loads the provided image file using Multipart Upload. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
file_data = File.new('/path/to/file') # File | The data of the document.
opts = {
  load_image_parameters: OpenapiClient::LoadImageParameters.new # LoadImageParameters | 
}

begin
  #Loads the provided image file using Multipart Upload.  Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.
  result = api_instance.image_load_multipart(file_data, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_load_multipart: #{e}"
end

Parameters

Name	Type	Description	Notes
file_data	File	The data of the document.
load_image_parameters	LoadImageParameters		[optional]

Return type

ImageLoadResponse

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: text/plain, application/json, text/json

image_micr

ImageMICRResponse image_micr(image_micr_parameters)

Performs MICR (Magnetic Ink Character Recognition) on a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_micr_parameters = OpenapiClient::ImageMICRParameters.new # ImageMICRParameters | An ImageMICRParameters object specifying the parameters of the action.

begin
  #Performs MICR (Magnetic Ink Character Recognition) on a previously uploaded image.
  result = api_instance.image_micr(image_micr_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_micr: #{e}"
end

Parameters

Name	Type	Description	Notes
image_micr_parameters	ImageMICRParameters	An ImageMICRParameters object specifying the parameters of the action.

Return type

ImageMICRResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_read_barcodes

ReadBarcodesResponse image_read_barcodes(image_read_barcodes_parameters)

Reads barcodes from a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_read_barcodes_parameters = OpenapiClient::ImageReadBarcodesParameters.new # ImageReadBarcodesParameters | An ImageReadBarcodesParameters object specifying the parameters of the action.

begin
  #Reads barcodes from a previously uploaded image.
  result = api_instance.image_read_barcodes(image_read_barcodes_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_read_barcodes: #{e}"
end

Parameters

Name	Type	Description	Notes
image_read_barcodes_parameters	ImageReadBarcodesParameters	An ImageReadBarcodesParameters object specifying the parameters of the action.

Return type

ReadBarcodesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_resize

ImageResizeResponse image_resize(image_resize_parameters)

Resizes a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_resize_parameters = OpenapiClient::ImageResizeParameters.new # ImageResizeParameters | An ImageResizeParameters object specifying the parameters for the action.

begin
  #Resizes a previously uploaded image.
  result = api_instance.image_resize(image_resize_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_resize: #{e}"
end

Parameters

Name	Type	Description	Notes
image_resize_parameters	ImageResizeParameters	An ImageResizeParameters object specifying the parameters for the action.

Return type

ImageResizeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_rotate

ImageRotateResponse image_rotate(image_rotate_parameters)

Rotates and/or flips a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_rotate_parameters = OpenapiClient::ImageRotateParameters.new # ImageRotateParameters | An ImageRotateParameters object specifying the parameters for the action.

begin
  #Rotates and/or flips a previously uploaded image.
  result = api_instance.image_rotate(image_rotate_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_rotate: #{e}"
end

Parameters

Name	Type	Description	Notes
image_rotate_parameters	ImageRotateParameters	An ImageRotateParameters object specifying the parameters for the action.

Return type

ImageRotateResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_jpeg

ImageSaveAsJPEGResponse image_save_as_jpeg(image_save_as_jpeg_parameters)

Saves a previously uploaded image as JPEG, and sends the file data in a JSON-serialized object.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_jpeg_parameters = OpenapiClient::ImageSaveAsJPEGParameters.new # ImageSaveAsJPEGParameters | An ImageSaveAsJPEGParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as JPEG, and sends the file data in a JSON-serialized object.
  result = api_instance.image_save_as_jpeg(image_save_as_jpeg_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_jpeg: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_jpeg_parameters	ImageSaveAsJPEGParameters	An ImageSaveAsJPEGParameters object specifying the parameters of the action.

Return type

ImageSaveAsJPEGResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_jpeg_file

File image_save_as_jpeg_file(image_save_as_jpeg_parameters)

Saves a previously uploaded image as JPEG, and streams the file binary data to the response (this is the most efficient download method).

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_jpeg_parameters = OpenapiClient::ImageSaveAsJPEGParameters.new # ImageSaveAsJPEGParameters | An ImageSaveAsJPEGParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as JPEG, and streams the file binary data to the response (this is the most efficient download method).
  result = api_instance.image_save_as_jpeg_file(image_save_as_jpeg_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_jpeg_file: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_jpeg_parameters	ImageSaveAsJPEGParameters	An ImageSaveAsJPEGParameters object specifying the parameters of the action.

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_pdf

ImageSaveAsPDFResponse image_save_as_pdf(image_save_as_pdf_parameters)

Saves a previously uploaded image as PDF, and sends the file data in a JSON-serialized object.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_pdf_parameters = OpenapiClient::ImageSaveAsPDFParameters.new # ImageSaveAsPDFParameters | An ImagesaveAsPDFParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as PDF, and sends the file data in a JSON-serialized object.
  result = api_instance.image_save_as_pdf(image_save_as_pdf_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_pdf: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_pdf_parameters	ImageSaveAsPDFParameters	An ImagesaveAsPDFParameters object specifying the parameters of the action.

Return type

ImageSaveAsPDFResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_pdf_file

File image_save_as_pdf_file(image_save_as_pdf_parameters)

Saves a previously uploaded image as PDF, and streams the file binary data to the response (this is the most efficient download method).

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_pdf_parameters = OpenapiClient::ImageSaveAsPDFParameters.new # ImageSaveAsPDFParameters | An ImagesaveAsPDFParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as PDF, and streams the file binary data to the response (this is the most efficient download method).
  result = api_instance.image_save_as_pdf_file(image_save_as_pdf_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_pdf_file: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_pdf_parameters	ImageSaveAsPDFParameters	An ImagesaveAsPDFParameters object specifying the parameters of the action.

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_pdfmrc

ImageSaveAsPDFMRCResponse image_save_as_pdfmrc(image_save_as_pdfmrc_parameters)

Saves a previously uploaded image as PDF using MRC compression, and sends the file data in a JSON-serialized object.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_pdfmrc_parameters = OpenapiClient::ImageSaveAsPDFMRCParameters.new # ImageSaveAsPDFMRCParameters | An ImagesaveAsPDFMRCParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as PDF using MRC compression, and sends the file data in a JSON-serialized object.
  result = api_instance.image_save_as_pdfmrc(image_save_as_pdfmrc_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_pdfmrc: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_pdfmrc_parameters	ImageSaveAsPDFMRCParameters	An ImagesaveAsPDFMRCParameters object specifying the parameters of the action.

Return type

ImageSaveAsPDFMRCResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_pdfmrc_file

File image_save_as_pdfmrc_file(image_save_as_pdfmrc_parameters)

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).

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_pdfmrc_parameters = OpenapiClient::ImageSaveAsPDFMRCParameters.new # ImageSaveAsPDFMRCParameters | An ImagesaveAsPDFMRCParameters object specifying the parameters of the action.

begin
  #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).
  result = api_instance.image_save_as_pdfmrc_file(image_save_as_pdfmrc_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_pdfmrc_file: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_pdfmrc_parameters	ImageSaveAsPDFMRCParameters	An ImagesaveAsPDFMRCParameters object specifying the parameters of the action.

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_png

ImageSaveAsPNGResponse image_save_as_png(image_save_as_png_parameters)

Saves a previously uploaded image as PNG, and sends the file data in a JSON-serialized object.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_png_parameters = OpenapiClient::ImageSaveAsPNGParameters.new # ImageSaveAsPNGParameters | An ImageSaveAsPNGParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as PNG, and sends the file data in a JSON-serialized object.
  result = api_instance.image_save_as_png(image_save_as_png_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_png: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_png_parameters	ImageSaveAsPNGParameters	An ImageSaveAsPNGParameters object specifying the parameters of the action.

Return type

ImageSaveAsPNGResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_png_file

File image_save_as_png_file(image_save_as_png_parameters)

Saves a previously uploaded image as PNG, and streams the file binary data to the response (this is the most efficient download method).

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_png_parameters = OpenapiClient::ImageSaveAsPNGParameters.new # ImageSaveAsPNGParameters | An ImageSaveAsPNGParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as PNG, and streams the file binary data to the response (this is the most efficient download method).
  result = api_instance.image_save_as_png_file(image_save_as_png_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_png_file: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_png_parameters	ImageSaveAsPNGParameters	An ImageSaveAsPNGParameters object specifying the parameters of the action.

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_tiff

ImageSaveAsTIFFResponse image_save_as_tiff(image_save_as_tiff_parameters)

Saves a previously uploaded image as TIFF, and sends the file data in a JSON-serialized object.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_tiff_parameters = OpenapiClient::ImageSaveAsTIFFParameters.new # ImageSaveAsTIFFParameters | An ImageSaveAsTIFFParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as TIFF, and sends the file data in a JSON-serialized object.
  result = api_instance.image_save_as_tiff(image_save_as_tiff_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_tiff: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_tiff_parameters	ImageSaveAsTIFFParameters	An ImageSaveAsTIFFParameters object specifying the parameters of the action.

Return type

ImageSaveAsTIFFResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_tiff_file

File image_save_as_tiff_file(image_save_as_tiff_parameters)

Saves a previously uploaded image as TIFF, and streams the file binary data to the response (this is the most efficient download method).

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_tiff_parameters = OpenapiClient::ImageSaveAsTIFFParameters.new # ImageSaveAsTIFFParameters | An ImageSaveAsTIFFParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as TIFF, and streams the file binary data to the response (this is the most efficient download method).
  result = api_instance.image_save_as_tiff_file(image_save_as_tiff_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_tiff_file: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_tiff_parameters	ImageSaveAsTIFFParameters	An ImageSaveAsTIFFParameters object specifying the parameters of the action.

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_tiff_multipage

ImageSaveAsTIFFMultipageResponse image_save_as_tiff_multipage(image_save_as_tiff_multipage_parameters)

Saves a previously uploaded image as multipage TIFF, and sends the file data in a JSON-serialized object.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_tiff_multipage_parameters = OpenapiClient::ImageSaveAsTIFFMultipageParameters.new # ImageSaveAsTIFFMultipageParameters | An ImageSaveAsTIFFMultipageParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as multipage TIFF, and sends the file data in a JSON-serialized object.
  result = api_instance.image_save_as_tiff_multipage(image_save_as_tiff_multipage_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_tiff_multipage: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_tiff_multipage_parameters	ImageSaveAsTIFFMultipageParameters	An ImageSaveAsTIFFMultipageParameters object specifying the parameters of the action.

Return type

ImageSaveAsTIFFMultipageResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_save_as_tiff_multipage_file

File image_save_as_tiff_multipage_file(image_save_as_tiff_multipage_parameters)

Saves a previously uploaded image as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_save_as_tiff_multipage_parameters = OpenapiClient::ImageSaveAsTIFFMultipageParameters.new # ImageSaveAsTIFFMultipageParameters | An ImageSaveAsTIFFMultipageParameters object specifying the parameters of the action.

begin
  #Saves a previously uploaded image as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).
  result = api_instance.image_save_as_tiff_multipage_file(image_save_as_tiff_multipage_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_save_as_tiff_multipage_file: #{e}"
end

Parameters

Name	Type	Description	Notes
image_save_as_tiff_multipage_parameters	ImageSaveAsTIFFMultipageParameters	An ImageSaveAsTIFFMultipageParameters object specifying the parameters of the action.

Return type

File

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

image_swap_pages

ImageSwapPagesResponse image_swap_pages(image_swap_pages_parameters)

Swaps two pages from a previously uploaded image.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::ImageApi.new
image_swap_pages_parameters = OpenapiClient::ImageSwapPagesParameters.new # ImageSwapPagesParameters | An ImageSwapPagesParameters object specifying the parameters of the action.

begin
  #Swaps two pages from a previously uploaded image.
  result = api_instance.image_swap_pages(image_swap_pages_parameters)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling ImageApi->image_swap_pages: #{e}"
end

Parameters

Name	Type	Description	Notes
image_swap_pages_parameters	ImageSwapPagesParameters	An ImageSwapPagesParameters object specifying the parameters of the action.

Return type

ImageSwapPagesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

Files

ImageApi.md

Latest commit

History

ImageApi.md

File metadata and controls

OpenapiClient::ImageApi

image_adjust

Example

Parameters

Return type

Authorization

HTTP request headers

image_auto_crop

Example

Parameters

Return type

Authorization

HTTP request headers

image_cleanup_document

Example

Parameters

Return type

Authorization

HTTP request headers

image_clone_regions

Example

Parameters

Return type

Authorization

HTTP request headers

image_close

Example

Parameters

Return type

Authorization

HTTP request headers

image_convert_color_depth

Example

Parameters

Return type

Authorization

HTTP request headers

image_crop

Example

Parameters

Return type

Authorization

HTTP request headers

image_delete_page

Example

Parameters

Return type

Authorization

HTTP request headers

image_detect_blank_pages

Example

Parameters

Return type

Authorization

HTTP request headers

image_detect_color

Example

Parameters

Return type

Authorization

HTTP request headers

image_detect_page_orientation

Example

Parameters

Return type

Authorization

HTTP request headers

image_filter

Example

Parameters

Return type

Authorization

HTTP request headers

image_get_page_thumbnail