class AsposeImagingCloud::ImagingApi

Aspose.Imaging Cloud API

Attributes

api_client[RW]

Public Class Methods

new(client_secret = nil, client_id = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v3.0', debug = false) click to toggle source

Initializes a new instance of the ImagingApi class. @param [String] client_secret Key to access the server. @param [String] client_id ID to access the server. @param [String] base_url Server URL. @param [String] api_version Api version. @param [Object] debug Debug switch [true, false].

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 40
def initialize(client_secret = nil, client_id = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v3.0', debug = false)
  @api_client = ApiClient.new(client_secret, client_id, base_url, api_version, debug)
end

Public Instance Methods

add_search_image(request) click to toggle source

Add image and images features to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream. @param [add_search_imageRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 47
def add_search_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, nil)
  nil
end
append_tiff(request) click to toggle source

Appends existing TIFF image to another existing TIFF image (i.e. merges TIFF images). @param [append_tiffRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 56
def append_tiff(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, nil)
  nil
end
compare_images(request) click to toggle source

Compare two images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream. @param [compare_imagesRequest] request Request object. @return [SearchResultsSet]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 65
def compare_images(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'SearchResultsSet')
end
convert_image(request) click to toggle source

Convert existing image to another format. @param [convert_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 73
def convert_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
convert_tiff_to_fax(request) click to toggle source

Update parameters of existing TIFF image accordingly to fax parameters. @param [convert_tiff_to_faxRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 81
def convert_tiff_to_fax(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
copy_file(request) click to toggle source

Copy file @param [copy_fileRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 89
def copy_file(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, nil)
  nil
end
copy_folder(request) click to toggle source

Copy folder @param [copy_folderRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 98
def copy_folder(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, nil)
  nil
end
create_converted_image(request) click to toggle source

Convert existing image to another format. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

@param [create_converted_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 107
def create_converted_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_cropped_image(request) click to toggle source

Crop an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_cropped_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 115
def create_cropped_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_deskewed_image(request) click to toggle source

Deskew an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_deskewed_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 123
def create_deskewed_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_fax_tiff(request) click to toggle source

Update parameters of TIFF image accordingly to fax parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_fax_tiffRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 131
def create_fax_tiff(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_folder(request) click to toggle source

Create the folder @param [create_folderRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 139
def create_folder(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, nil)
  nil
end
create_grayscaled_image(request) click to toggle source

Grayscales an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_grayscaled_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 148
def create_grayscaled_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_image_features(request) click to toggle source

Extract images features and add them to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_image_featuresRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 156
def create_image_features(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, nil)
  nil
end
create_image_frame(request) click to toggle source

Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_image_frameRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 165
def create_image_frame(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_image_frame_range(request) click to toggle source

Get frames range from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_image_frame_rangeRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 173
def create_image_frame_range(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_image_tag(request) click to toggle source

Add tag and reference image to search context. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_image_tagRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 189
def create_image_tag(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, nil)
  nil
end
create_modified_bmp(request) click to toggle source

Update parameters of BMP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_bmpRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 198
def create_modified_bmp(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_emf(request) click to toggle source

Process existing EMF imaging using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_emfRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 206
def create_modified_emf(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_gif(request) click to toggle source

Update parameters of GIF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_gifRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 214
def create_modified_gif(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_jpeg(request) click to toggle source

Update parameters of JPEG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_jpegRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 222
def create_modified_jpeg(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_jpeg2000(request) click to toggle source

Update parameters of JPEG2000 image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_jpeg2000Request] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 230
def create_modified_jpeg2000(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_psd(request) click to toggle source

Update parameters of PSD image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_psdRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 238
def create_modified_psd(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_svg(request) click to toggle source

Update parameters of SVG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_svgRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 246
def create_modified_svg(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_tiff(request) click to toggle source

Update parameters of TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_tiffRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 254
def create_modified_tiff(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_web_p(request) click to toggle source

Update parameters of WEBP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_web_pRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 262
def create_modified_web_p(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_modified_wmf(request) click to toggle source

Process existing WMF image using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_modified_wmfRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 270
def create_modified_wmf(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_object_bounds(request) click to toggle source

Detects objects bounds. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_object_boundsRequest] request Request object. @return [DetectedObjectList]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 278
def create_object_bounds(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'DetectedObjectList')
end
create_resized_image(request) click to toggle source

Resize an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_resized_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 286
def create_resized_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_rotate_flipped_image(request) click to toggle source

Rotate and/or flip an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_rotate_flipped_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 294
def create_rotate_flipped_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_updated_image(request) click to toggle source

Perform scaling, cropping and flipping of an image in a single request. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [create_updated_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 302
def create_updated_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_visual_object_bounds(request) click to toggle source

Detects objects bounds and draw them on the original image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream @param [create_visual_object_boundsRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 310
def create_visual_object_bounds(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'File')
end
create_web_site_image_features(request) click to toggle source

Extract images features from web page and add them to search context @param [create_web_site_image_featuresRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 318
def create_web_site_image_features(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, nil)
  nil
end
crop_image(request) click to toggle source

Crop an existing image. @param [crop_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 327
def crop_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
delete_file(request) click to toggle source

Delete file @param [delete_fileRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 335
def delete_file(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :DELETE, nil)
  nil
end
delete_folder(request) click to toggle source

Delete folder @param [delete_folderRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 344
def delete_folder(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :DELETE, nil)
  nil
end
delete_image_features(request) click to toggle source

Deletes image features from search context. @param [delete_image_featuresRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 353
def delete_image_features(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :DELETE, nil)
  nil
end
delete_search_image(request) click to toggle source

Delete image and images features from search context @param [delete_search_imageRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 371
def delete_search_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :DELETE, nil)
  nil
end
deskew_image(request) click to toggle source

Deskew an existing image. @param [deskew_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 380
def deskew_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
download_file(request) click to toggle source

Download file @param [download_fileRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 388
def download_file(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
extract_image_features(request) click to toggle source

Extract features from image without adding to search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream. @param [extract_image_featuresRequest] request Request object. @return [ImageFeatures]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 396
def extract_image_features(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'ImageFeatures')
end
extract_image_frame_properties(request) click to toggle source

Get separate frame properties of existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [extract_image_frame_propertiesRequest] request Request object. @return [ImagingResponse]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 404
def extract_image_frame_properties(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'ImagingResponse')
end
extract_image_properties(request) click to toggle source

Get properties of an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [extract_image_propertiesRequest] request Request object. @return [ImagingResponse]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 412
def extract_image_properties(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'ImagingResponse')
end
filter_effect_image(request) click to toggle source

Apply filtering effects to an existing image. @param [filter_effect_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 420
def filter_effect_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, 'File')
end
find_image_duplicates(request) click to toggle source

Find images duplicates. @param [find_image_duplicatesRequest] request Request object. @return [ImageDuplicatesSet]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 428
def find_image_duplicates(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'ImageDuplicatesSet')
end
find_images_by_tags(request) click to toggle source

Find images by tags. Tags JSON string is passed as zero-indexed multipart/form-data content or as raw body stream. @param [find_images_by_tagsRequest] request Request object. @return [SearchResultsSet]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 436
def find_images_by_tags(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'SearchResultsSet')
end
find_similar_images(request) click to toggle source

Find similar images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream. @param [find_similar_imagesRequest] request Request object. @return [SearchResultsSet]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 444
def find_similar_images(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'SearchResultsSet')
end
get_available_labels(request) click to toggle source

Gets available labels for selected object detection method. @param [get_available_labelsRequest] request Request object. @return [AvailableLabelsList]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 452
def get_available_labels(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'AvailableLabelsList')
end
get_disc_usage(request) click to toggle source

Get disc usage @param [get_disc_usageRequest] request Request object. @return [DiscUsage]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 460
def get_disc_usage(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'DiscUsage')
end
get_file_versions(request) click to toggle source

Get file versions @param [get_file_versionsRequest] request Request object. @return [FileVersions]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 468
def get_file_versions(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'FileVersions')
end
get_files_list(request) click to toggle source

Get all files and folders within a folder @param [get_files_listRequest] request Request object. @return [FilesList]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 476
def get_files_list(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'FilesList')
end
get_image_features(request) click to toggle source

Gets image features from search context. @param [get_image_featuresRequest] request Request object. @return [ImageFeatures]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 484
def get_image_features(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'ImageFeatures')
end
get_image_frame(request) click to toggle source

Get separate frame from existing image. @param [get_image_frameRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 492
def get_image_frame(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
get_image_frame_properties(request) click to toggle source

Get separate frame properties of existing image. @param [get_image_frame_propertiesRequest] request Request object. @return [ImagingResponse]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 500
def get_image_frame_properties(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'ImagingResponse')
end
get_image_frame_range(request) click to toggle source

Get frames range from existing image. @param [get_image_frame_rangeRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 508
def get_image_frame_range(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
get_image_properties(request) click to toggle source

Get properties of an image. @param [get_image_propertiesRequest] request Request object. @return [ImagingResponse]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 516
def get_image_properties(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'ImagingResponse')
end
get_image_search_status(request) click to toggle source

Gets the search context status. @param [get_image_search_statusRequest] request Request object. @return [SearchContextStatus]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 524
def get_image_search_status(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'SearchContextStatus')
end
get_object_bounds(request) click to toggle source

Detects objects’ bounds @param [get_object_boundsRequest] request Request object. @return [DetectedObjectList]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 532
def get_object_bounds(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'DetectedObjectList')
end
get_search_image(request) click to toggle source

Get image from search context @param [get_search_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 540
def get_search_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
get_visual_object_bounds(request) click to toggle source

Detects objects bounds and draw them on the original image @param [get_visual_object_boundsRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 548
def get_visual_object_bounds(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
grayscale_image(request) click to toggle source

Grayscale an existing image. @param [grayscale_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 556
def grayscale_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_bmp(request) click to toggle source

Update parameters of existing BMP image. @param [modify_bmpRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 564
def modify_bmp(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_emf(request) click to toggle source

Process existing EMF imaging using given parameters. @param [modify_emfRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 572
def modify_emf(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_gif(request) click to toggle source

Update parameters of existing GIF image. @param [modify_gifRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 580
def modify_gif(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_jpeg(request) click to toggle source

Update parameters of existing JPEG image. @param [modify_jpegRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 588
def modify_jpeg(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_jpeg2000(request) click to toggle source

Update parameters of existing JPEG2000 image. @param [modify_jpeg2000Request] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 596
def modify_jpeg2000(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_psd(request) click to toggle source

Update parameters of existing PSD image. @param [modify_psdRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 604
def modify_psd(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_svg(request) click to toggle source

Update parameters of existing SVG image. @param [modify_svgRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 612
def modify_svg(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_tiff(request) click to toggle source

Update parameters of existing TIFF image. @param [modify_tiffRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 620
def modify_tiff(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_web_p(request) click to toggle source

Update parameters of existing WEBP image. @param [modify_web_pRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 628
def modify_web_p(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
modify_wmf(request) click to toggle source

Process existing WMF image using given parameters. @param [modify_wmfRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 636
def modify_wmf(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
move_file(request) click to toggle source

Move file @param [move_fileRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 644
def move_file(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, nil)
  nil
end
move_folder(request) click to toggle source

Move folder @param [move_folderRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 653
def move_folder(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, nil)
  nil
end
object_exists(request) click to toggle source

Check if file or folder exists @param [object_existsRequest] request Request object. @return [ObjectExist]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 662
def object_exists(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'ObjectExist')
end
resize_image(request) click to toggle source

Resize an existing image. @param [resize_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 670
def resize_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
rotate_flip_image(request) click to toggle source

Rotate and/or flip an existing image. @param [rotate_flip_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 678
def rotate_flip_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
storage_exists(request) click to toggle source

Check if storage exists @param [storage_existsRequest] request Request object. @return [StorageExist]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 686
def storage_exists(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'StorageExist')
end
update_image(request) click to toggle source

Perform scaling, cropping and flipping of an existing image in a single request. @param [update_imageRequest] request Request object. @return [File]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 694
def update_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :GET, 'File')
end
update_image_features(request) click to toggle source

Update images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream. @param [update_image_featuresRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 702
def update_image_features(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, nil)
  nil
end
update_search_image(request) click to toggle source

Update image and images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream. @param [update_search_imageRequest] request Request object. @return [nil]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 711
def update_search_image(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, nil)
  nil
end
upload_file(request) click to toggle source

Upload file @param [upload_fileRequest] request Request object. @return [FilesUploadResult]

# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 720
def upload_file(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :PUT, 'FilesUploadResult')
end

Private Instance Methods

call_api(http_request, method, return_type) click to toggle source
# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 733
def call_api(http_request, method, return_type)
  response = @api_client.call_api(method,
                                  http_request.resource_path,
                                  header_params: http_request.header_params,
                                  query_params: http_request.query_params,
                                  form_params: http_request.form_params,
                                  body: http_request.body,
                                  auth_names: http_request.auth_names,
                                  return_type: return_type)
  response[0]
end
ensure_token() click to toggle source
# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 745
def ensure_token
  request_token unless @api_client.config.access_token
end
make_request(http_request, method, return_type) click to toggle source
# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 727
def make_request(http_request, method, return_type)
  ensure_token
  call_api(http_request, method, return_type)

end
request_token() click to toggle source
# File lib/aspose-imaging-cloud/api/imaging_api.rb, line 749
def request_token
  config = @api_client.config
  request_url = '/connect/token'
  form_params =
    {
      'grant_type': 'client_credentials',
      'client_id': config.api_key[:client_id],
      'client_secret': config.api_key[:api_key]
    }

  header_params =
    {
      'Accept' => 'application/json',
      'Content-Type' =>'application/x-www-form-urlencoded'
    }

  base_path = @api_client.config.base_path
  @api_client.config.base_path = ''

  data = @api_client.call_api(:POST, request_url,
                              header_params: header_params,
                              form_params: form_params,
                              return_type: 'Object')
  access_token = data[0]['access_token'.to_sym]

  @api_client.config.base_path = base_path
  @api_client.config.access_token = access_token
end