Namespaces
product
Methods and types of the `product` namespace (`client.product` / `bot.product`).
Interfaces
GetWorkspaceProductsParams
Properties
| Property | Type |
|---|---|
paymentProvider? | "stripe" | "manualInvoice" |
productType? | "basePlan" | "addSeat" | "addStorage" | "addCredits" | "enableBoards" |
Type Aliases
ProductResponse
type ProductResponse = Product;SupportedCurrency
type SupportedCurrency = "gbp" | "usd" | "eur";Functions
default()
function default(client): {
getSuggestedCurrency: Promise<{
country: string | null;
currency: SupportedCurrency;
locked?: boolean;
supported: SupportedCurrency[];
}>;
getWorkspaceProducts: Promise<Product[]>;
listPlans: Promise<Product[]>;
};Defines product-related methods for the NuramaClient.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | default | The NuramaClient instance. |
Returns
An object containing the product-related methods.
| Name | Type | Description |
|---|---|---|
getSuggestedCurrency() | () => Promise<{ country: string | null; currency: SupportedCurrency; locked?: boolean; supported: SupportedCurrency[]; }> | Suggested billing currency for the caller, derived server-side from the CDN geo header. A default for the currency selector only — the user can override. Falls back to usd with no geo header. |
getWorkspaceProducts() | (workspaceId, params?) => Promise<Product[]> | Retrieves available products for a specific workspace, considering restrictions. Requires authentication and permission. |
listPlans() | () => Promise<Product[]> | The base-plan catalogue. Works signed out: without a session it is the public catalogue (active, unrestricted plans). With one it also has the promo plans restricted to the caller (restricted: true) and leaves out a Demo they've already used. Plans carry only their public fields — no restrictTo, notes or payment-provider ids. |