Class: Uploadcare::Api::Rest::Groups

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

Overview

REST API endpoint for group operations.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rest:) ⇒ Groups

Returns a new instance of Groups.

Parameters:



13
14
15
 
# File 'lib/uploadcare/api/rest/groups.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/groups.rb', line 10

def rest
  @rest
end

Instance Method Details

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

Delete a group by UUID.

Parameters:

  • uuid (String) —

    Group UUID (formatted as UUID~size)

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

    Request options

Returns:

See Also:



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

def delete(uuid:, request_options: {})
  encoded_uuid = URI::DEFAULT_PARSER.escape(uuid.to_s, /[^A-Za-z0-9\-._~]/)
  rest.request(method: :delete, path: "/groups/#{encoded_uuid}/", params: {}, headers: {},
               request_options: request_options)
end

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

Get group information by UUID.

Parameters:

  • uuid (String) —

    Group UUID (formatted as UUID~size)

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

    Request options

Returns:

See Also:



33
34
35
36
 
# File 'lib/uploadcare/api/rest/groups.rb', line 33

def info(uuid:, request_options: {})
  encoded_uuid = URI::DEFAULT_PARSER.escape(uuid.to_s, /[^A-Za-z0-9\-._~]/)
  rest.get(path: "/groups/#{encoded_uuid}/", params: {}, headers: {}, request_options: request_options)
end

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

List groups with optional filtering and pagination.

Parameters:

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

    Query parameters (limit, ordering, etc.)

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

    Request options

Returns:

See Also:



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

def list(params: {}, request_options: {})
  rest.get(path: '/groups/', params: params, headers: {}, request_options: request_options)
end