AssetsResource

API reference for the Assets resource.

Methods

list

List all assets with optional filtering and pagination.

async list(options?: ListOptions): Promise<ListResponse<Asset>>

Parameters:

Name	Type	Description
options.page.number	number	Page number
options.page.size	number	Items per page
options.sort	string	Sort field
options.filter	Record<string, any>	Filter criteria

Returns: ListResponse<Asset>

Example:

const response = await client.assets.list({
  filter: { status: 'Active' }
});

---

get

Get a single asset by ID.

async get(id: string, options?: { include?: string[] }): Promise<Asset>

---

create

Create a new asset.

async create(data: CreateAssetInput): Promise<Asset>

Parameters:

interface CreateAssetInput {
  assetDesc: string;
  assetCat: string;
  assetOwner?: string;
  assetCriticality?: string;
  assetRisk?: string;
  nextReviewDate?: Date;
}

---

update

Update an existing asset.

async update(id: string, data: UpdateAssetInput): Promise<Asset>

Parameters:

interface UpdateAssetInput extends Partial<CreateAssetInput> {
  status?: 'Active' | 'Decommissioned';
}

---

delete

Delete an asset.

async delete(id: string): Promise<void>

---

review

Mark an asset as reviewed.

async review(id: string, reviewNotes?: string): Promise<Asset>

Types

Asset

interface Asset {
  id: string;
  type: 'asset';
  assetDesc: string;
  assetCat: string;
  assetOwner?: string;
  assetCriticality?: string;
  assetRisk?: string;
  status: 'Active' | 'Decommissioned' | 'Deleted';
  nextReviewDate?: Date;
  lastReviewDate?: Date;
  createdAt: Date;
  updatedAt: Date;
  metadata?: Record<string, unknown>;
}