Class: BtcPay::Client::Api::ApiKeys

Inherits:

Base

• Object
• Service
• Base
• BtcPay::Client::Api::ApiKeys

Defined in:

lib/btcpay/client/api/api_keys.rb

Constant Summary

PATH =

'/api-keys'

Instance Method Summary

• #create(payload, **opts) ⇒ Object
• #current(**opts) ⇒ Object (also: #get, #info)
• #revoke(key, **opts) ⇒ Object (also: #delete)
• #revoke!(**opts) ⇒ Object (also: #delete!)

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

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from BtcPay::Client::Service

Instance Method Details

#create(payload, **opts) ⇒ Object

See Also:

• https://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) ⇒ Object Also known as: get, info

See Also:

• https://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

#revoke(key, **opts) ⇒ Object Also known as: delete

See Also:

• https://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

#revoke!(**opts) ⇒ Object Also known as: delete!

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