Class: AsposeImagingCloud::ImagingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-imaging-cloud/api/imaging_api.rb

Overview

Aspose.Imaging Cloud API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_secret = nil, client_id = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v3.0', debug = false) ⇒ ImagingApi

Initializes a new instance of the ImagingApi class.

Parameters:

  • client_secret (String) (defaults to: nil) —

    Key to access the server.

  • client_id (String) (defaults to: nil) —

    ID to access the server.

  • base_url (String) (defaults to: 'api-qa.aspose.cloud') —

    Server URL.

  • api_version (String) (defaults to: 'v3.0') —

    Api version.

  • debug (Object) (defaults to: false) —

    Debug switch [true, false].



40
41
42
 
# 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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



32
33
34
 
# File 'lib/aspose-imaging-cloud/api/imaging_api.rb', line 32

def api_client
  @api_client
end

Instance Method Details

#add_search_image(request) ⇒ nil

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.

Parameters:

  • request (add_search_imageRequest) —

    Request object.

Returns:

  • (nil) 


47
48
49
50
51
 
# 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) ⇒ nil

Appends existing TIFF image to another existing TIFF image (i.e. merges TIFF images).

Parameters:

  • request (append_tiffRequest) —

    Request object.

Returns:

  • (nil) 


56
57
58
59
60
 
# 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) ⇒ SearchResultsSet

Compare two images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (compare_imagesRequest) —

    Request object.

Returns:



65
66
67
68
 
# 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) ⇒ File

Convert existing image to another format.

Parameters:

  • request (convert_imageRequest) —

    Request object.

Returns:

  • (File) 


73
74
75
76
 
# 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) ⇒ File

Update parameters of existing TIFF image accordingly to fax parameters.

Parameters:

  • request (convert_tiff_to_faxRequest) —

    Request object.

Returns:

  • (File) 


81
82
83
84
 
# 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) ⇒ nil

Copy file

Parameters:

  • request (copy_fileRequest) —

    Request object.

Returns:

  • (nil) 


89
90
91
92
93
 
# 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) ⇒ nil

Copy folder

Parameters:

  • request (copy_folderRequest) —

    Request object.

Returns:

  • (nil) 


98
99
100
101
102
 
# 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) ⇒ File

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

Parameters:

  • request (create_converted_imageRequest) —

    Request object.

Returns:

  • (File) 


107
108
109
110
 
# 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) ⇒ File

Crop an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_cropped_imageRequest) —

    Request object.

Returns:

  • (File) 


115
116
117
118
 
# 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) ⇒ File

Deskew an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_deskewed_imageRequest) —

    Request object.

Returns:

  • (File) 


123
124
125
126
 
# 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) ⇒ File

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.

Parameters:

  • request (create_fax_tiffRequest) —

    Request object.

Returns:

  • (File) 


131
132
133
134
 
# 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) ⇒ nil

Create the folder

Parameters:

  • request (create_folderRequest) —

    Request object.

Returns:

  • (nil) 


139
140
141
142
143
 
# 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) ⇒ File

Grayscales an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_grayscaled_imageRequest) —

    Request object.

Returns:

  • (File) 


148
149
150
151
 
# 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) ⇒ nil

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.

Parameters:

  • request (create_image_featuresRequest) —

    Request object.

Returns:

  • (nil) 


156
157
158
159
160
 
# 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) ⇒ File

Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_image_frameRequest) —

    Request object.

Returns:

  • (File) 


165
166
167
168
 
# 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) ⇒ File

Get frames range from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_image_frame_rangeRequest) —

    Request object.

Returns:

  • (File) 


173
174
175
176
 
# 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_search(request) ⇒ SearchContextStatus

Create new search context.

Parameters:

  • request (create_image_searchRequest) —

    Request object.

Returns:



181
182
183
184
 
# File 'lib/aspose-imaging-cloud/api/imaging_api.rb', line 181

def create_image_search(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :POST, 'SearchContextStatus')
end

#create_image_tag(request) ⇒ nil

Add tag and reference image to search context. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_image_tagRequest) —

    Request object.

Returns:

  • (nil) 


189
190
191
192
193
 
# 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) ⇒ File

Update parameters of BMP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_bmpRequest) —

    Request object.

Returns:

  • (File) 


198
199
200
201
 
# 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) ⇒ File

Process existing EMF imaging using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_emfRequest) —

    Request object.

Returns:

  • (File) 


206
207
208
209
 
# 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) ⇒ File

Update parameters of GIF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_gifRequest) —

    Request object.

Returns:

  • (File) 


214
215
216
217
 
# 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) ⇒ File

Update parameters of JPEG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_jpegRequest) —

    Request object.

Returns:

  • (File) 


222
223
224
225
 
# 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) ⇒ File

Update parameters of JPEG2000 image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_jpeg2000Request) —

    Request object.

Returns:

  • (File) 


230
231
232
233
 
# 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) ⇒ File

Update parameters of PSD image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_psdRequest) —

    Request object.

Returns:

  • (File) 


238
239
240
241
 
# 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) ⇒ File

Update parameters of SVG image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_svgRequest) —

    Request object.

Returns:

  • (File) 


246
247
248
249
 
# 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) ⇒ File

Update parameters of TIFF image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_tiffRequest) —

    Request object.

Returns:

  • (File) 


254
255
256
257
 
# 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) ⇒ File

Update parameters of WEBP image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_web_pRequest) —

    Request object.

Returns:

  • (File) 


262
263
264
265
 
# 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) ⇒ File

Process existing WMF image using given parameters. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_modified_wmfRequest) —

    Request object.

Returns:

  • (File) 


270
271
272
273
 
# 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) ⇒ DetectedObjectList

Detects objects bounds. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_object_boundsRequest) —

    Request object.

Returns:



278
279
280
281
 
# 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) ⇒ File

Resize an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_resized_imageRequest) —

    Request object.

Returns:

  • (File) 


286
287
288
289
 
# 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) ⇒ File

Rotate and/or flip an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (create_rotate_flipped_imageRequest) —

    Request object.

Returns:

  • (File) 


294
295
296
297
 
# 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) ⇒ File

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.

Parameters:

  • request (create_updated_imageRequest) —

    Request object.

Returns:

  • (File) 


302
303
304
305
 
# 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) ⇒ File

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

Parameters:

  • request (create_visual_object_boundsRequest) —

    Request object.

Returns:

  • (File) 


310
311
312
313
 
# 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) ⇒ nil

Extract images features from web page and add them to search context

Parameters:

  • request (create_web_site_image_featuresRequest) —

    Request object.

Returns:

  • (nil) 


318
319
320
321
322
 
# 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) ⇒ File

Crop an existing image.

Parameters:

  • request (crop_imageRequest) —

    Request object.

Returns:

  • (File) 


327
328
329
330
 
# 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) ⇒ nil

Delete file

Parameters:

  • request (delete_fileRequest) —

    Request object.

Returns:

  • (nil) 


335
336
337
338
339
 
# 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) ⇒ nil

Delete folder

Parameters:

  • request (delete_folderRequest) —

    Request object.

Returns:

  • (nil) 


344
345
346
347
348
 
# 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) ⇒ nil

Deletes image features from search context.

Parameters:

  • request (delete_image_featuresRequest) —

    Request object.

Returns:

  • (nil) 


353
354
355
356
357
 
# 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_image_search(request) ⇒ nil

Deletes the search context.

Parameters:

  • request (delete_image_searchRequest) —

    Request object.

Returns:

  • (nil) 


362
363
364
365
366
 
# File 'lib/aspose-imaging-cloud/api/imaging_api.rb', line 362

def delete_image_search(request)
  http_request = request.to_http_info(@api_client.config)
  make_request(http_request, :DELETE, nil)
  nil
end

#delete_search_image(request) ⇒ nil

Delete image and images features from search context

Parameters:

  • request (delete_search_imageRequest) —

    Request object.

Returns:

  • (nil) 


371
372
373
374
375
 
# 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) ⇒ File

Deskew an existing image.

Parameters:

  • request (deskew_imageRequest) —

    Request object.

Returns:

  • (File) 


380
381
382
383
 
# 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) ⇒ File

Download file

Parameters:

  • request (download_fileRequest) —

    Request object.

Returns:

  • (File) 


388
389
390
391
 
# 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) ⇒ ImageFeatures

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.

Parameters:

  • request (extract_image_featuresRequest) —

    Request object.

Returns:



396
397
398
399
 
# 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) ⇒ ImagingResponse

Get separate frame properties of existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (extract_image_frame_propertiesRequest) —

    Request object.

Returns:



404
405
406
407
 
# 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) ⇒ ImagingResponse

Get properties of an image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (extract_image_propertiesRequest) —

    Request object.

Returns:



412
413
414
415
 
# 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) ⇒ File

Apply filtering effects to an existing image.

Parameters:

  • request (filter_effect_imageRequest) —

    Request object.

Returns:

  • (File) 


420
421
422
423
 
# 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) ⇒ ImageDuplicatesSet

Find images duplicates.

Parameters:

  • request (find_image_duplicatesRequest) —

    Request object.

Returns:



428
429
430
431
 
# 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) ⇒ SearchResultsSet

Find images by tags. Tags JSON string is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (find_images_by_tagsRequest) —

    Request object.

Returns:



436
437
438
439
 
# 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) ⇒ SearchResultsSet

Find similar images. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (find_similar_imagesRequest) —

    Request object.

Returns:



444
445
446
447
 
# 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) ⇒ AvailableLabelsList

Gets available labels for selected object detection method.

Parameters:

  • request (get_available_labelsRequest) —

    Request object.

Returns:



452
453
454
455
 
# 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) ⇒ DiscUsage

Get disc usage

Parameters:

  • request (get_disc_usageRequest) —

    Request object.

Returns:



460
461
462
463
 
# 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) ⇒ FileVersions

Get file versions

Parameters:

  • request (get_file_versionsRequest) —

    Request object.

Returns:



468
469
470
471
 
# 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) ⇒ FilesList

Get all files and folders within a folder

Parameters:

  • request (get_files_listRequest) —

    Request object.

Returns:



476
477
478
479
 
# 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) ⇒ ImageFeatures

Gets image features from search context.

Parameters:

  • request (get_image_featuresRequest) —

    Request object.

Returns:



484
485
486
487
 
# 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) ⇒ File

Get separate frame from existing image.

Parameters:

  • request (get_image_frameRequest) —

    Request object.

Returns:

  • (File) 


492
493
494
495
 
# 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) ⇒ ImagingResponse

Get separate frame properties of existing image.

Parameters:

  • request (get_image_frame_propertiesRequest) —

    Request object.

Returns:



500
501
502
503
 
# 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) ⇒ File

Get frames range from existing image.

Parameters:

  • request (get_image_frame_rangeRequest) —

    Request object.

Returns:

  • (File) 


508
509
510
511
 
# 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) ⇒ ImagingResponse

Get properties of an image.

Parameters:

  • request (get_image_propertiesRequest) —

    Request object.

Returns:



516
517
518
519
 
# 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) ⇒ SearchContextStatus

Gets the search context status.

Parameters:

  • request (get_image_search_statusRequest) —

    Request object.

Returns:



524
525
526
527
 
# 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) ⇒ DetectedObjectList

Detects objects’ bounds

Parameters:

  • request (get_object_boundsRequest) —

    Request object.

Returns:



532
533
534
535
 
# 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) ⇒ File

Get image from search context

Parameters:

  • request (get_search_imageRequest) —

    Request object.

Returns:

  • (File) 


540
541
542
543
 
# 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) ⇒ File

Detects objects bounds and draw them on the original image

Parameters:

  • request (get_visual_object_boundsRequest) —

    Request object.

Returns:

  • (File) 


548
549
550
551
 
# 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) ⇒ File

Grayscale an existing image.

Parameters:

  • request (grayscale_imageRequest) —

    Request object.

Returns:

  • (File) 


556
557
558
559
 
# 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) ⇒ File

Update parameters of existing BMP image.

Parameters:

  • request (modify_bmpRequest) —

    Request object.

Returns:

  • (File) 


564
565
566
567
 
# 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) ⇒ File

Process existing EMF imaging using given parameters.

Parameters:

  • request (modify_emfRequest) —

    Request object.

Returns:

  • (File) 


572
573
574
575
 
# 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) ⇒ File

Update parameters of existing GIF image.

Parameters:

  • request (modify_gifRequest) —

    Request object.

Returns:

  • (File) 


580
581
582
583
 
# 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) ⇒ File

Update parameters of existing JPEG image.

Parameters:

  • request (modify_jpegRequest) —

    Request object.

Returns:

  • (File) 


588
589
590
591
 
# 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) ⇒ File

Update parameters of existing JPEG2000 image.

Parameters:

  • request (modify_jpeg2000Request) —

    Request object.

Returns:

  • (File) 


596
597
598
599
 
# 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) ⇒ File

Update parameters of existing PSD image.

Parameters:

  • request (modify_psdRequest) —

    Request object.

Returns:

  • (File) 


604
605
606
607
 
# 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) ⇒ File

Update parameters of existing SVG image.

Parameters:

  • request (modify_svgRequest) —

    Request object.

Returns:

  • (File) 


612
613
614
615
 
# 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) ⇒ File

Update parameters of existing TIFF image.

Parameters:

  • request (modify_tiffRequest) —

    Request object.

Returns:

  • (File) 


620
621
622
623
 
# 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) ⇒ File

Update parameters of existing WEBP image.

Parameters:

  • request (modify_web_pRequest) —

    Request object.

Returns:

  • (File) 


628
629
630
631
 
# 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) ⇒ File

Process existing WMF image using given parameters.

Parameters:

  • request (modify_wmfRequest) —

    Request object.

Returns:

  • (File) 


636
637
638
639
 
# 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) ⇒ nil

Move file

Parameters:

  • request (move_fileRequest) —

    Request object.

Returns:

  • (nil) 


644
645
646
647
648
 
# 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) ⇒ nil

Move folder

Parameters:

  • request (move_folderRequest) —

    Request object.

Returns:

  • (nil) 


653
654
655
656
657
 
# 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) ⇒ ObjectExist

Check if file or folder exists

Parameters:

  • request (object_existsRequest) —

    Request object.

Returns:



662
663
664
665
 
# 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) ⇒ File

Resize an existing image.

Parameters:

  • request (resize_imageRequest) —

    Request object.

Returns:

  • (File) 


670
671
672
673
 
# 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) ⇒ File

Rotate and/or flip an existing image.

Parameters:

  • request (rotate_flip_imageRequest) —

    Request object.

Returns:

  • (File) 


678
679
680
681
 
# 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) ⇒ StorageExist

Check if storage exists

Parameters:

  • request (storage_existsRequest) —

    Request object.

Returns:



686
687
688
689
 
# 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) ⇒ File

Perform scaling, cropping and flipping of an existing image in a single request.

Parameters:

  • request (update_imageRequest) —

    Request object.

Returns:

  • (File) 


694
695
696
697
 
# 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) ⇒ nil

Update images features in search context. Image data may be passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • request (update_image_featuresRequest) —

    Request object.

Returns:

  • (nil) 


702
703
704
705
706
 
# 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) ⇒ nil

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.

Parameters:

  • request (update_search_imageRequest) —

    Request object.

Returns:

  • (nil) 


711
712
713
714
715
 
# 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) ⇒ FilesUploadResult

Upload file

Parameters:

  • request (upload_fileRequest) —

    Request object.

Returns:



720
721
722
723
 
# 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