class BtcPay::Client::Api::Store

Constants

PATH

Public Instance Methods

all(**opts) click to toggle source

@see docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_GetStores

# File lib/btcpay/client/api/store.rb, line 10
def all(**opts)
  client.get(path, options: opts)
end
Also aliased as: stores, index
create(payload, **opts) click to toggle source

@see docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores/post

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

@see docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores~1{storeId}/delete

# File lib/btcpay/client/api/store.rb, line 35
def delete(store_id, **opts)
  client.delete(path(store_id), options: opts)
end
get(store_id, **opts) click to toggle source

@see docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_GetStore

# File lib/btcpay/client/api/store.rb, line 23
def get(store_id, **opts)
  client.get(path(store_id), options: opts)
end
index(**opts)
Alias for: all
invoices() click to toggle source

services

# File lib/btcpay/client/api/store.rb, line 42
def invoices
  @invoices ||= Api::StoreInvoices.new(client: client)
end
payment_requests() click to toggle source
# File lib/btcpay/client/api/store.rb, line 46
def payment_requests
  @payment_requests ||= Api::StorePaymentRequests.new(client: client)
end
payouts() click to toggle source
# File lib/btcpay/client/api/store.rb, line 50
def payouts
  @payouts ||= Api::StorePayouts.new(client: client)
end
pull_payments() click to toggle source
# File lib/btcpay/client/api/store.rb, line 54
def pull_payments
  @pull_payments ||= Api::StorePullPayments.new(client: client)
end
put(store_id, payload, **opts)
Alias for: update
stores(**opts)
Alias for: all
update(store_id, payload, **opts) click to toggle source

@see docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_UpdateStore

# File lib/btcpay/client/api/store.rb, line 28
def update(store_id, payload, **opts)
  client.put(path(store_id), payload: payload, options: opts)
end
Also aliased as: put

Protected Instance Methods

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