Class: Uploadcare::Api::Rest::Project

Inherits:

Object

• Object
• Uploadcare::Api::Rest::Project

Defined in:

lib/uploadcare/api/rest/project.rb

Overview

REST API endpoint for project information.

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Project

Instance Attribute Summary

• #rest ⇒ Uploadcare::Api::Rest readonly

  Parent REST client.

Instance Method Summary

• #initialize(rest:) ⇒ Project constructor

  A new instance of Project.

• #show(request_options: {}) ⇒ Uploadcare::Result

  Get current project information.

Constructor Details

#initialize(rest:) ⇒ Project

Returns a new instance of Project.

Parameters:

• rest (Uploadcare::Api::Rest) —

  Parent REST client

# File 'lib/uploadcare/api/rest/project.rb', line 11

def initialize(rest:)
  @rest = rest
end

Instance Attribute Details

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

Returns Parent REST client.

Returns:

• (Uploadcare::Api::Rest) —

  Parent REST client

# File 'lib/uploadcare/api/rest/project.rb', line 8

def rest
  @rest
end

Instance Method Details

#show(request_options: {}) ⇒ Uploadcare::Result

Get current project information.

Parameters:

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

  Request options

Returns:

• (Uploadcare::Result) —

  Project details (name, pub_key, autostore_enabled, collaborators)

See Also:

• https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Project

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

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