Class: Uploadcare::Rails::Api::Rest::ConversionApi

Inherits:

Base

• Object
• Base
• Uploadcare::Rails::Api::Rest::ConversionApi

Defined in:

lib/uploadcare/rails/api/rest/conversion_api.rb

Overview

A class that contains Conversion related methods for Uploadcare REST API

Class Method Summary

• .convert_document(document_params, options = {}) ⇒ Object

  Converts documents.

• .convert_video(video_params, options = {}) ⇒ Object

  Converts video files.

• .get_document_conversion_formats_info(uuid) ⇒ Object

  Conversion formats info.

• .get_document_conversion_status(token) ⇒ Object

  Returns a status of video conversion job.

• .get_video_conversion_status(token) ⇒ Object

  Returns a status of video conversion job.

Class Method Details

.convert_document(document_params, options = {}) ⇒ Object

Converts documents

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/documentConvert

# File 'lib/uploadcare/rails/api/rest/conversion_api.rb', line 32

def convert_document(document_params, options = {})
  Uploadcare::DocumentConverter.convert(document_params, options)
end

.convert_video(video_params, options = {}) ⇒ Object

Converts video files

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/videoConvert

# File 'lib/uploadcare/rails/api/rest/conversion_api.rb', line 14

def convert_video(video_params, options = {})
  Uploadcare::VideoConverter.convert(video_params, options)
end

.get_document_conversion_formats_info(uuid) ⇒ Object

Conversion formats info

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Conversion/operation/documentConvertInfo

# File 'lib/uploadcare/rails/api/rest/conversion_api.rb', line 26

def get_document_conversion_formats_info(uuid)
  Uploadcare::DocumentConverter.info(uuid)
end

.get_document_conversion_status(token) ⇒ Object

Returns a status of video conversion job

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/documentConvertStatus

# File 'lib/uploadcare/rails/api/rest/conversion_api.rb', line 38

def get_document_conversion_status(token)
  Uploadcare::DocumentConverter.status(token)
end

.get_video_conversion_status(token) ⇒ Object

Returns a status of video conversion job

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/videoConvertStatus

# File 'lib/uploadcare/rails/api/rest/conversion_api.rb', line 20

def get_video_conversion_status(token)
  Uploadcare::VideoConverter.status(token)
end