Class: Rocksky::Resources::Apikey

Inherits:
Base
  • Object
show all
Defined in:
lib/rocksky/resources/apikey.rb

Overview

‘app.rocksky.apikey.*` endpoints. All require an authenticated client.

Instance Attribute Summary

Attributes inherited from Base

#http

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Rocksky::Resources::Base

Instance Method Details

#create_apikey(name:, description: nil) ⇒ Object

Create a new API key.



11
12
13
14
 
# File 'lib/rocksky/resources/apikey.rb', line 11

def create_apikey(name:, description: nil)
  body = { name: name, description: description }.compact
  procedure("app.rocksky.apikey.createApikey", body: body)
end

#get_apikeys(limit: nil, offset: nil) ⇒ Object

List your API keys.



6
7
8
 
# File 'lib/rocksky/resources/apikey.rb', line 6

def get_apikeys(limit: nil, offset: nil)
  query("app.rocksky.apikey.getApikeys", limit: limit, offset: offset)
end

#remove_apikey(id:) ⇒ Object

Remove an API key.



23
24
25
 
# File 'lib/rocksky/resources/apikey.rb', line 23

def remove_apikey(id:)
  procedure("app.rocksky.apikey.removeApikey", params: { id: id })
end

#update_apikey(id:, name: nil, description: nil) ⇒ Object

Update an API key.



17
18
19
20
 
# File 'lib/rocksky/resources/apikey.rb', line 17

def update_apikey(id:, name: nil, description: nil)
  body = { id: id, name: name, description: description }.compact
  procedure("app.rocksky.apikey.updateApikey", body: body)
end