Implemented Knowledge base API - Schemas

Author: Femi-Godpower

README.md

@@ -1,49 +1,37 @@
-# Ominity API Module Template
+# Ominity API Module: Knowledgebase
 
 This is a template repo for creating a modular Ominity API package that plugs into `@ominity/api-typescript`.
 
-See `RENAME_CHECKLIST.md` for the exact rename steps.
-
-## What to Rename
-
-- Package name in `package.json`
-- Source dialect in `package.json` (`@ominity/api-modules-template/source`)
-- Module name inside `src/sdk/index.ts`
-- Folder names under `src/models` and `src/funcs`
-- README examples
-
-If you plan to publish, remove `"private": true` in `package.json`.
-
 ## Install
 
 ```bash
-npm install @ominity/api-typescript
+npm install @ominity/api-typescript @ominity/api-module-knowledgebase
 ```
 
 ## Usage (example)
 
 ```ts
 import { Ominity } from "@ominity/api-typescript";
-import { bookingsModule, BookingsModule } from "@ominity/api-modules-bookings";
+import { knowledgebaseModule, KnowledgebaseModule } from "@ominity/api-module-knowledgebase";
 
 const ominity = new Ominity({
   serverURL: "https://tenant-a.ominity.com/api",
   security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
 });
 
 // Either option is supported
-ominity.use(BookingsModule);
+ominity.use(KnowledgebaseModule);
 // or
-ominity.use(bookingsModule());
+ominity.use(knowledgebaseModule());
 
 // Constructor option
 const ominity2 = new Ominity({
   serverURL: "https://tenant-a.ominity.com/api",
   security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
-  modules: [bookingsModule()],
+  modules: [knowledgebaseModule()],
 });
 
-const res = await ominity.modules.bookings.events.list({ page: 1, limit: 20 });
+const res = await ominity.modules.knowledgebase.events.list({ page: 1, limit: 20 });
 console.log(res.items);
 ```
 

RENAME_CHECKLIST.md

@@ -1,5 +1,5 @@
 {
-  "name": "ominity-api-modules-template",
+  "name": "@ominity/api-module-knowledgebase",
   "version": "0.0.0",
   "exports": {
     ".": "./src/index.ts",
@@ -18,4 +18,4 @@
       "src/**/*.ts"
     ]
   }
-}
+}