Class: Uploadcare::Api::Rest::Addons

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

Overview

REST API endpoint for add-on operations.

Supports AWS Rekognition (labels & moderation), ClamAV virus scan, and Remove.bg.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rest:) ⇒ Addons

Returns a new instance of Addons.

Parameters:



13
14
15
 
# File 'lib/uploadcare/api/rest/addons.rb', line 13

def initialize(rest:)
  @rest = rest
end

Instance Attribute Details

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

Returns Parent REST client.

Returns:



10
11
12
 
# File 'lib/uploadcare/api/rest/addons.rb', line 10

def rest
  @rest
end

Instance Method Details

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

Execute AWS Rekognition label detection.

Parameters:

  • uuid (String) —

    File UUID to process

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

    Request options

Returns:

See Also:



23
24
25
26
 
# File 'lib/uploadcare/api/rest/addons.rb', line 23

def aws_rekognition_detect_labels(uuid:, request_options: {})
  rest.post(path: '/addons/aws_rekognition_detect_labels/execute/',
            params: { target: uuid }, headers: {}, request_options: request_options)
end

#aws_rekognition_detect_labels_status(request_id:, request_options: {}) ⇒ Uploadcare::Result

Check AWS Rekognition label detection status.

Parameters:

  • request_id (String) —

    Request ID from execution

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

    Request options

Returns:

See Also:



34
35
36
37
 
# File 'lib/uploadcare/api/rest/addons.rb', line 34

def aws_rekognition_detect_labels_status(request_id:, request_options: {})
  rest.get(path: '/addons/aws_rekognition_detect_labels/execute/status/',
           params: { request_id: request_id }, headers: {}, request_options: request_options)
end

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

Execute AWS Rekognition moderation label detection.

Parameters:

  • uuid (String) —

    File UUID to process

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

    Request options

Returns:

See Also:



45
46
47
48
 
# File 'lib/uploadcare/api/rest/addons.rb', line 45

def aws_rekognition_detect_moderation_labels(uuid:, request_options: {})
  rest.post(path: '/addons/aws_rekognition_detect_moderation_labels/execute/',
            params: { target: uuid }, headers: {}, request_options: request_options)
end

#aws_rekognition_detect_moderation_labels_status(request_id:, request_options: {}) ⇒ Uploadcare::Result

Check AWS Rekognition moderation label detection status.

Parameters:

  • request_id (String) —

    Request ID from execution

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

    Request options

Returns:

See Also:



56
57
58
59
 
# File 'lib/uploadcare/api/rest/addons.rb', line 56

def aws_rekognition_detect_moderation_labels_status(request_id:, request_options: {})
  rest.get(path: '/addons/aws_rekognition_detect_moderation_labels/execute/status/',
           params: { request_id: request_id }, headers: {}, request_options: request_options)
end

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

Execute Remove.bg background removal.

Parameters:

  • uuid (String) —

    File UUID to process

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

    Optional parameters for the add-on

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

    Request options

Returns:

See Also:



92
93
94
95
 
# File 'lib/uploadcare/api/rest/addons.rb', line 92

def remove_bg(uuid:, params: {}, request_options: {})
  rest.post(path: '/addons/remove_bg/execute/',
            params: { target: uuid, params: params }, headers: {}, request_options: request_options)
end

#remove_bg_status(request_id:, request_options: {}) ⇒ Uploadcare::Result

Check Remove.bg execution status.

Parameters:

  • request_id (String) —

    Request ID from execution

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

    Request options

Returns:

See Also:



103
104
105
106
 
# File 'lib/uploadcare/api/rest/addons.rb', line 103

def remove_bg_status(request_id:, request_options: {})
  rest.get(path: '/addons/remove_bg/execute/status/',
           params: { request_id: request_id }, headers: {}, request_options: request_options)
end

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

Execute ClamAV virus scan.

Parameters:

  • uuid (String) —

    File UUID to process

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

    Optional scan parameters

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

    Request options

Returns:

See Also:



68
69
70
71
72
 
# File 'lib/uploadcare/api/rest/addons.rb', line 68

def uc_clamav_virus_scan(uuid:, params: {}, request_options: {})
  body = { target: uuid }.merge(params)
  rest.post(path: '/addons/uc_clamav_virus_scan/execute/', params: body, headers: {},
            request_options: request_options)
end

#uc_clamav_virus_scan_status(request_id:, request_options: {}) ⇒ Uploadcare::Result

Check ClamAV virus scan status.

Parameters:

  • request_id (String) —

    Request ID from execution

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

    Request options

Returns:

See Also:



80
81
82
83
 
# File 'lib/uploadcare/api/rest/addons.rb', line 80

def uc_clamav_virus_scan_status(request_id:, request_options: {})
  rest.get(path: '/addons/uc_clamav_virus_scan/execute/status/',
           params: { request_id: request_id }, headers: {}, request_options: request_options)
end