BlueForge Docs

client.wallet.getAutoRefill

Get auto-refill configuration for a workspace

Signature

class Client {
  wallet: {
    getAutoRefill(workspaceId: string): Promise<{ config: AutoRefillConfig | null }>
  }
}

Parameters

NameTypeRequiredNotes
workspaceId
string
YesWorkspace ID

Throws

  • NotFoundError
    — workspace not found

Examples

import { Client } from '@blueforge/client'

const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })

const { config } = await bf.wallet.getAutoRefill('ws_abc')

Pitfalls

  • Null config — returns 
    { config: null }
    if no auto-refill has been configured; this is not an error

See also

  • client.wallet.configureAutoRefill
  • client.wallet.createRefillSession

Tested against

  • Unit: 
    packages/client/src/__tests__/wallet.test.ts