Nurama Developers
Namespaces

storage

Methods and types of the `storage` namespace (`client.storage` / `bot.storage`).

Interfaces

ChartDataEntry

Properties

PropertyType
averageSizeInBytesnumber
periodstring

GetStorageChartParams

Properties

PropertyType
aggregationPeriod?"month" | "year" | "day" | "week"
endDate?number
startDate?number

StorageRecord

Properties

PropertyType
idstring
resourceIdstring
resourceTypeResourceType
sizeInBytesnumber

Type Aliases

ChartDataResponse

type ChartDataResponse = ChartDataEntry[];

ResourceType

type ResourceType = "user" | "workspace" | "project" | "chat" | "asset";

StorageMethods

type StorageMethods = ReturnType<typeof default>;

Functions

default()

function default(client): {
  getStorageChart: Promise<ChartDataResponse>;
  getStorageRecord: Promise<StorageRecord>;
};

Defines storage-related methods for the NuramaClient.

Parameters

ParameterTypeDescription
clientdefaultThe NuramaClient instance.

Returns

An object containing the storage-related methods.

NameTypeDescription
getStorageChart()( resourceType, resourceId, params? ) => Promise<ChartDataResponse>Retrieves storage usage chart data for a specific resource. Requires authentication and permission.
getStorageRecord()(resourceType, resourceId) => Promise<StorageRecord>Retrieves the latest storage record for a specific resource. Requires authentication and permission.

On this page