Class: Uploadcare::Client::DocumentConversionsAccessor

Inherits:
Object
  • Object
show all
Defined in:
lib/uploadcare/client/document_conversions_accessor.rb

Overview

High-level document conversion helpers scoped to a client instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ DocumentConversionsAccessor

Returns a new instance of DocumentConversionsAccessor.

Parameters:



8
9
10
 
# File 'lib/uploadcare/client/document_conversions_accessor.rb', line 8

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



5
6
7
 
# File 'lib/uploadcare/client/document_conversions_accessor.rb', line 5

def client
  @client
end

Instance Method Details

#convert(uuid:, format:, options: {}, request_options: {}) ⇒ Hash

Parameters:

  • uuid (String)
  • format (String, Symbol)
  • options (Hash) (defaults to: {})
  • request_options (Hash) (defaults to: {})

Returns:

  • (Hash) 


17
18
19
20
21
22
 
# File 'lib/uploadcare/client/document_conversions_accessor.rb', line 17

def convert(uuid:, format:, options: {}, request_options: {})
  Uploadcare::Resources::DocumentConversion.convert_document(
    params: { uuid: uuid, format: format }, options: options, client: client,
    request_options: request_options
  )
end

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

Parameters:

  • uuid (String)
  • request_options (Hash) (defaults to: {})

Returns:



36
37
38
39
40
 
# File 'lib/uploadcare/client/document_conversions_accessor.rb', line 36

def info(uuid:, request_options: {})
  Uploadcare::Resources::DocumentConversion.info_for(
    uuid: uuid, client: client, request_options: request_options
  )
end

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

Parameters:

  • token (String)
  • request_options (Hash) (defaults to: {})

Returns:



27
28
29
30
31
 
# File 'lib/uploadcare/client/document_conversions_accessor.rb', line 27

def status(token:, request_options: {})
  Uploadcare::Resources::DocumentConversion.status(
    token: token, client: client, request_options: request_options
  )
end