metanomos-ts-client-spec v1.0.1

TypeScript Settings Catalog API Client

A TypeScript client for the Settings Catalog API, generated using OpenAPI Generator.

Installation

Install the package using npm:

npm install metanomos-ts-client-spec

Or using yarn:

yarn add metanomos-ts-client-spec

Configuration

Initialize the API client with your configuration:

import {
  Configuration,
  SettingsCatalogControllerApi,
} from "metanomos-ts-client-spec";

const config = new Configuration({
  basePath: "https://your-api-base-url",
  // Add any additional configuration like headers, auth tokens, etc.
});

const api = new SettingsCatalogControllerApi(config);

Usage Examples

Get Top Level Settings

const topLevelSettings = await api.getTopLevelSettings();

Get Form Data List

const formDataList = await api.getFormDataList({ catalogId: 1 });

Save Form Data

const formData = {
  name: "Test Form",
  description: "Test Description",
};

const result = await api.saveFormData({
  catalogId: 1,
  body: JSON.stringify(formData),
});

Get Form Schema

const schema = await api.getFormSchema({ catalogId: 1 });

Available Methods

• deleteFormData: Delete form data by ID
• getFormDataList: Get list of form data for a catalog
• getFormSchema: Get form schema for a catalog
• getKnowledgeBaseFormDataDetails: Get knowledge base form data details
• getKnowledgeBaseList: Get list of knowledge bases
• getLlmFormDataDetails: Get LLM form data details
• getServiceCatalogElements: Get service catalog elements
• getTopLevelSettings: Get top level settings
• makeKnowledgeBasePrimary: Make a knowledge base primary
• saveFormData: Save new form data
• updateFormData: Update existing form data

Error Handling

The client includes built-in error handling. Example:

try {
  const formData = await api.getFormDataList({ catalogId: 1 });
} catch (error) {
  if (error instanceof Error) {
    console.error("API Error:", error.message);
  }
}