Platform API ClientClient group3 methodsMeteringMethods

Metering

Manage milestone thresholds and list webhook delivery outcomes for usage milestone notifications.

Milestone configWebhook delivery history

Metering

metering.getMilestones()

Generated exampleHTTP endpoint wrapperGET /api/v1/metering/milestones

GET /api/v1/metering/milestones

Signature

getMilestones(): Promise<MilestoneConfigResponse>

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const response = await client.metering.getMilestones();
console.log(response);

Response

// Response type
Promise<MilestoneConfigResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

metering.updateMilestones()

Generated exampleHTTP endpoint wrapperPUT /api/v1/metering/milestones

PUT /api/v1/metering/milestones

Signature

updateMilestones(input: { configs: MilestoneConfigInput[] }): Promise<MilestoneConfigResponse>

Parameters

Name	Type	Flags
input	{ configs: MilestoneConfigInput[] }	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const input = {} as { configs: MilestoneConfigInput[] };
// Fill the input payload fields before calling this method.

const response = await client.metering.updateMilestones(input);
console.log(response);

Response

// Response type
Promise<MilestoneConfigResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

metering.listMilestoneDeliveries()

Generated exampleHTTP endpoint wrapperGET /api/v1/metering/milestones/deliveries

GET /api/v1/metering/milestones/deliveries

Signature

listMilestoneDeliveries(params?: {
    operationType?: string;
    status?: string;
    cursor?: string;
    limit?: number;
  }): Promise<MilestoneDeliveryListResponse>

Parameters

Name	Type	Flags
params	{ operationType?: string; status?: string; cursor?: string; limit?: number; }	optional

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const params = {} as {
    operationType?: string;
    status?: string;
    cursor?: string;
    limit?: number;
  };
// Fill the params payload fields before calling this method.

const response = await client.metering.listMilestoneDeliveries(params);
console.log(response);

Response

// Response type
Promise<MilestoneDeliveryListResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));