yaebal
Available methods

getBusinessAccountStarBalance()

Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.

parameters

parametertyperequireddescription
business_connection_idstringrequiredUnique identifier of the business connection

returns

StarAmount

usage in yaebal

getBusinessAccountStarBalance is directly typed on Api — call it straight off bot.api.

bot.ts 
import type { GetBusinessAccountStarBalanceParams } from "@yaebal/types";

await bot.api.getBusinessAccountStarBalance({
  business_connection_id: "...",
} satisfies GetBusinessAccountStarBalanceParams);

context shortcut

also available as ctx.getBusinessAccountStarBalance() on 4 context types — see @yaebal/contexts.

context shortcut 
/** Returns the amount of Telegram Stars owned by a managed business account. Requires the *can\_view\_gifts\_and\_stars* business bot right. Returns [StarAmount](https://core.telegram.org/bots/api/#staramount) on success. */
ctx.getBusinessAccountStarBalance(params?: Omit<GetBusinessAccountStarBalanceParams, "business_connection_id"> & { business_connection_id?: string })
official Bot API docs: https://core.telegram.org/bots/api/#getbusinessaccountstarbalance