Class: Uploadcare::Api::Rest::DocumentConversions

Inherits:
Object
  • Object
show all
Defined in:
lib/uploadcare/api/rest/document_conversions.rb

Overview

REST API endpoint for document conversion operations.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rest:) ⇒ DocumentConversions

Returns a new instance of DocumentConversions.

Parameters:



11
12
13
 
# File 'lib/uploadcare/api/rest/document_conversions.rb', line 11

def initialize(rest:)
  @rest = rest
end

Instance Attribute Details

#rest ⇒ Uploadcare::Api::Rest (readonly)

Returns Parent REST client.

Returns:



8
9
10
 
# File 'lib/uploadcare/api/rest/document_conversions.rb', line 8

def rest
  @rest
end

Instance Method Details

#convert(paths:, options: {}, request_options: {}) ⇒ Uploadcare::Result

Convert a document to a specified format.

Parameters:

  • paths (Array<String>) —

    Conversion paths (e.g., ["uuid/document/-/format/pdf/"])

  • options (Hash) (defaults to: {}) —

    Optional parameters (:store, :save_in_group)

  • request_options (Hash) (defaults to: {}) —

    Request options

Returns:

See Also:



34
35
36
37
38
39
40
41
 
# File 'lib/uploadcare/api/rest/document_conversions.rb', line 34

def convert(paths:, options: {}, request_options: {})
  body = { paths: paths }
  body[:store] = normalize_bool_param(options[:store]) if options.key?(:store)
  body[:save_in_group] = normalize_bool_param(options[:save_in_group]) if options.key?(:save_in_group)
  body.compact!

  rest.post(path: '/convert/document/', params: body, headers: {}, request_options: request_options)
end

#info(uuid:, request_options: {}) ⇒ Uploadcare::Result

Get document format information and possible conversion formats.

Parameters:

  • uuid (String) —

    Document file UUID

  • request_options (Hash) (defaults to: {}) —

    Request options

Returns:

See Also:



21
22
23
24
25
 
# File 'lib/uploadcare/api/rest/document_conversions.rb', line 21

def info(uuid:, request_options: {})
  encoded_uuid = URI.encode_www_form_component(uuid.to_s)
  rest.get(path: "/convert/document/#{encoded_uuid}/", params: {}, headers: {},
           request_options: request_options)
end

#status(token:, request_options: {}) ⇒ Uploadcare::Result

Get document conversion job status.

Parameters:

  • token (String, Integer) —

    Conversion job token

  • request_options (Hash) (defaults to: {}) —

    Request options

Returns:

See Also:



49
50
51
52
 
# File 'lib/uploadcare/api/rest/document_conversions.rb', line 49

def status(token:, request_options: {})
  rest.get(path: "/convert/document/status/#{token}/", params: {}, headers: {},
           request_options: request_options)
end