class BtcPay::Client::Api::ApiKeys

Constants

PATH

Public Instance Methods

create(payload, **opts) click to toggle source

@see docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys/post

# File lib/btcpay/client/api/api_keys.rb, line 18
def create(payload, **opts)
  client.post(path, payload: payload, options: opts)
end
current(**opts) click to toggle source

@see docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1current/get

# File lib/btcpay/client/api/api_keys.rb, line 10
def current(**opts)
  client.get(path('current'), options: opts)
end
Also aliased as: get, info
delete(key, **opts)
Alias for: revoke
delete!(**opts)
Alias for: revoke!
get(**opts)
Alias for: current
info(**opts)
Alias for: current
revoke(key, **opts) click to toggle source

@see docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1{apikey}/delete

# File lib/btcpay/client/api/api_keys.rb, line 23
def revoke(key, **opts)
  client.delete(path(key), options: opts)
end
Also aliased as: delete
revoke!(**opts) click to toggle source

docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1current/delete

# File lib/btcpay/client/api/api_keys.rb, line 30
def revoke!(**opts)
  client.delete(path('current'), options: opts)
end
Also aliased as: delete!

Protected Instance Methods

set_base_path() click to toggle source
# File lib/btcpay/client/api/api_keys.rb, line 38
def set_base_path
  @base_path = PATH
end