Platform API ClientClient group4 methodsApprovalsMethods

approvals

Reference methods for approvals.

Approvals

approvals.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/namespaces/approvals

GET /api/v1/namespaces/approvals

Signature

list(params?: {
    status?: ApprovalStatus;
    limit?: number;
    offset?: number;
  }): Promise<ApprovalListResponse>

Parameters

Name	Type	Flags
params	{ status?: ApprovalStatus; limit?: number; offset?: 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 {
    status?: ApprovalStatus;
    limit?: number;
    offset?: number;
  };
// Fill the params payload fields before calling this method.

const response = await client.approvals.list(params);
console.log(response);

Response

// Response type
Promise<ApprovalListResponse>

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

approvals.resolve()

Generated exampleHTTP endpoint wrapperPOST /api/v1/approvals/{approvalId}/resolve

POST /api/v1/approvals/{approvalId}/resolve

Signature

resolve(approvalId: string, input: ApprovalResolveInput): Promise<ApprovalResolveResponse>

Parameters

Name	Type	Flags
approvalId	string	required
input	ApprovalResolveInput	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 approvalId = "<approvalId>";
const input = {} as ApprovalResolveInput;

const response = await client.approvals.resolve(approvalId, input);
console.log(response);

Response

// Response type
Promise<ApprovalResolveResponse>

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

approvals.getConfig()

Generated exampleHTTP endpoint wrapperGET /api/v1/namespaces/approvals

GET /api/v1/namespaces/approvals

Signature

getConfig(): Promise<{ data: ApprovalConfig | null }>

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.approvals.getConfig();
console.log(response);

Response

// Response type
Promise<{ data: ApprovalConfig | null }>

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

approvals.updateConfig()

Generated exampleHTTP endpoint wrapperPOST /api/v1/namespaces/approvals

POST /api/v1/namespaces/approvals

Signature

updateConfig(input: ApprovalConfigInput): Promise<{ data: ApprovalConfig }>

Parameters

Name	Type	Flags
input	ApprovalConfigInput	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 ApprovalConfigInput;
// Fill the input payload fields before calling this method.

const response = await client.approvals.updateConfig(input);
console.log(response);

Response

// Response type
Promise<{ data: ApprovalConfig }>

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