pyrus-api 3.3.2 → 3.4.0

package/README.md

@@ -283,11 +283,95 @@ const announcementResponse = await client.announcements.addComment(
 ```
 
 * Create an announcement
-  
+
 ```typescript
 const announcementResponse = await client.announcements.create(
     {
         text: "New announcement"
     }
 );
-```
+```
+
+## Knowledge Base
+
+* Get a knowledge base entity (article or topic)
+
+```typescript
+const response = await client.knowledgeBase.get("LMcleQRnRqB");
+```
+
+* Create an article
+
+```typescript
+import {KnowledgeBaseEntityType} from "pyrus-api";
+```
+
+```typescript
+const response = await client.knowledgeBase.create(
+    {
+        type: KnowledgeBaseEntityType.Article,
+        title: "My Article",
+        body: "Article content in MD format",
+        parent_topic_id: "KoSjtyL9EWm"
+    }
+);
+```
+
+* Create a topic
+
+```typescript
+const response = await client.knowledgeBase.create(
+    {
+        type: KnowledgeBaseEntityType.Topic,
+        title: "My Topic"
+    }
+);
+```
+
+* Update a knowledge base entity
+
+```typescript
+const response = await client.knowledgeBase.update(
+    "LMcleQRnRqB",
+    {
+        title: "Updated Title",
+        body: "Updated content in MD format"
+    }
+);
+```
+
+* Delete a knowledge base entity
+
+```typescript
+const response = await client.knowledgeBase.delete("LMcleQRnRqB", true);
+```
+
+* Get knowledge base structure
+
+```typescript
+const response = await client.knowledgeBase.getStructure(
+    {
+        parent_topic_id: "KoSjtyL9EWm",
+        depth: 2
+    }
+);
+```
+
+* Get knowledge base entity permissions
+
+```typescript
+const response = await client.knowledgeBase.getPermissions("KoSjtyL9EWm");
+```
+
+* Update knowledge base entity permissions
+
+```typescript
+const response = await client.knowledgeBase.updatePermissions(
+    "KoSjtyL9EWm",
+    {
+        inherit: false,
+        readers: [1732, 4368],
+        editors: [2434]
+    }
+);
+```

package/build/cjs/index.cjs

@@ -45,6 +45,8 @@ const allDateAndTimeResponseKeys = [
     "scheduled_date",
     "scheduled_datetime_utc",
     "close_date",
+    "created_at",
+    "updated_at",
 ];
 const dateRequestKeys = ["due_date", "scheduled_date"];
 const dateTimeRequestKeys = [
@@ -60,6 +62,8 @@ const dateTimeRequestKeys = [
     "scheduled_datetime_utc",
     "start_time",
     "end_time",
+    "created_at",
+    "updated_at",
 ];
 
 exports.OperatorId = void 0;
@@ -100,10 +104,10 @@ function extractDates(key, value) {
 }
 function packDates(key, value) {
     if (dateRequestKeys.includes(key)) {
-        return value && toDateString(value);
+        return this[key] && toDateString(this[key]);
     }
     if (dateTimeRequestKeys.includes(key)) {
-        return value && toDateTimeString(value);
+        return this[key] && toDateTimeString(this[key]);
     }
     if (value instanceof Object && value.type && value.value) {
         if (dateTimeFieldTypes.includes(value.type)) {
@@ -129,16 +133,22 @@ function trimTrailingSlash(url) {
 function toDateTimeString(date) {
     if (typeof date === "string")
         return date;
+    if (date == null || typeof date.toISOString !== "function")
+        return String(date);
     return date.toISOString().split(".")[0] + "Z";
 }
 function toDateString(date) {
     if (typeof date === "string")
         return date;
+    if (date == null || typeof date.toISOString !== "function")
+        return String(date);
     return date.toISOString().split("T")[0];
 }
 function toTimeString(date) {
     if (typeof date === "string")
         return date;
+    if (date == null || typeof date.toISOString !== "function")
+        return String(date);
     return date.toISOString().split("T")[1].slice(0, 5);
 }
 function processFilters(filters) {
@@ -187,6 +197,17 @@ class ApiError extends Error {
     }
 }
 
+const KnowledgeBaseEntityType = {
+    Article: "article",
+    Topic: "topic",
+};
+
+const KnowledgeBasePermissionLevel = {
+    None: "none",
+    Read: "read",
+    Write: "write",
+};
+
 const FilterMask = {
     Due: 0x1,
     DueDate: 0x2,
@@ -555,6 +576,9 @@ var Endpoints;
     Endpoints["Call"] = "/call";
     Endpoints["AttachCallRecord"] = "/attachcallrecord";
     Endpoints["Bots"] = "/bots";
+    Endpoints["KnowledgeBase"] = "/knowledgebase";
+    Endpoints["Structure"] = "/structure";
+    Endpoints["Permissions"] = "/permissions";
 })(Endpoints || (Endpoints = {}));
 
 class RoleApi extends BaseApi {
@@ -941,6 +965,51 @@ class BotApi extends BaseApi {
     }
 }
 
+class KnowledgeBaseApi extends BaseApi {
+    constructor() {
+        super(...arguments);
+        this._moduleSubPath = Endpoints.KnowledgeBase;
+    }
+    get(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}`, "GET");
+        });
+    }
+    create(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi(yield this.getModulePath(), "POST", JSON.stringify(request));
+        });
+    }
+    update(id, request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}`, "PUT", JSON.stringify(request));
+        });
+    }
+    delete(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, deleteWithChildren = false) {
+            return yield this.fetchApi((yield this.getModulePath()) +
+                `/${id}?delete_with_children=${deleteWithChildren}`, "DELETE");
+        });
+    }
+    getStructure(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const basePath = (yield this.getModulePath()) + Endpoints.Structure;
+            const url = request ? basePath + toSearchParams(request) : basePath;
+            return yield this.fetchApi(url, "GET");
+        });
+    }
+    getPermissions(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.Permissions, "GET");
+        });
+    }
+    updatePermissions(id, request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.Permissions, "PUT", JSON.stringify(request));
+        });
+    }
+}
+
 class PyrusApiClient extends BaseApi {
     constructor(auth, settings) {
         const currentSettings = !!settings
@@ -1048,6 +1117,11 @@ class PyrusApiClient extends BaseApi {
             this._bot = new BotApi(this.initParams);
         return this._bot;
     }
+    get knowledgeBase() {
+        if (!this._knowledgeBase)
+            this._knowledgeBase = new KnowledgeBaseApi(this.initParams);
+        return this._knowledgeBase;
+    }
 }
 
 exports.ActivityAction = ActivityAction;
@@ -1058,6 +1132,8 @@ exports.ErrorCodeType = ErrorCodeType;
 exports.FilterMask = FilterMask;
 exports.Flag = Flag;
 exports.FormFieldType = FormFieldType;
+exports.KnowledgeBaseEntityType = KnowledgeBaseEntityType;
+exports.KnowledgeBasePermissionLevel = KnowledgeBasePermissionLevel;
 exports.ListType = ListType;
 exports.PermissionLevel = PermissionLevel;
 exports.PersonType = PersonType;

package/build/esm/index.js

@@ -43,6 +43,8 @@ const allDateAndTimeResponseKeys = [
     "scheduled_date",
     "scheduled_datetime_utc",
     "close_date",
+    "created_at",
+    "updated_at",
 ];
 const dateRequestKeys = ["due_date", "scheduled_date"];
 const dateTimeRequestKeys = [
@@ -58,6 +60,8 @@ const dateTimeRequestKeys = [
     "scheduled_datetime_utc",
     "start_time",
     "end_time",
+    "created_at",
+    "updated_at",
 ];
 
 var OperatorId;
@@ -98,10 +102,10 @@ function extractDates(key, value) {
 }
 function packDates(key, value) {
     if (dateRequestKeys.includes(key)) {
-        return value && toDateString(value);
+        return this[key] && toDateString(this[key]);
     }
     if (dateTimeRequestKeys.includes(key)) {
-        return value && toDateTimeString(value);
+        return this[key] && toDateTimeString(this[key]);
     }
     if (value instanceof Object && value.type && value.value) {
         if (dateTimeFieldTypes.includes(value.type)) {
@@ -127,16 +131,22 @@ function trimTrailingSlash(url) {
 function toDateTimeString(date) {
     if (typeof date === "string")
         return date;
+    if (date == null || typeof date.toISOString !== "function")
+        return String(date);
     return date.toISOString().split(".")[0] + "Z";
 }
 function toDateString(date) {
     if (typeof date === "string")
         return date;
+    if (date == null || typeof date.toISOString !== "function")
+        return String(date);
     return date.toISOString().split("T")[0];
 }
 function toTimeString(date) {
     if (typeof date === "string")
         return date;
+    if (date == null || typeof date.toISOString !== "function")
+        return String(date);
     return date.toISOString().split("T")[1].slice(0, 5);
 }
 function processFilters(filters) {
@@ -185,6 +195,17 @@ class ApiError extends Error {
     }
 }
 
+const KnowledgeBaseEntityType = {
+    Article: "article",
+    Topic: "topic",
+};
+
+const KnowledgeBasePermissionLevel = {
+    None: "none",
+    Read: "read",
+    Write: "write",
+};
+
 const FilterMask = {
     Due: 0x1,
     DueDate: 0x2,
@@ -553,6 +574,9 @@ var Endpoints;
     Endpoints["Call"] = "/call";
     Endpoints["AttachCallRecord"] = "/attachcallrecord";
     Endpoints["Bots"] = "/bots";
+    Endpoints["KnowledgeBase"] = "/knowledgebase";
+    Endpoints["Structure"] = "/structure";
+    Endpoints["Permissions"] = "/permissions";
 })(Endpoints || (Endpoints = {}));
 
 class RoleApi extends BaseApi {
@@ -939,6 +963,51 @@ class BotApi extends BaseApi {
     }
 }
 
+class KnowledgeBaseApi extends BaseApi {
+    constructor() {
+        super(...arguments);
+        this._moduleSubPath = Endpoints.KnowledgeBase;
+    }
+    get(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}`, "GET");
+        });
+    }
+    create(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi(yield this.getModulePath(), "POST", JSON.stringify(request));
+        });
+    }
+    update(id, request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}`, "PUT", JSON.stringify(request));
+        });
+    }
+    delete(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, deleteWithChildren = false) {
+            return yield this.fetchApi((yield this.getModulePath()) +
+                `/${id}?delete_with_children=${deleteWithChildren}`, "DELETE");
+        });
+    }
+    getStructure(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const basePath = (yield this.getModulePath()) + Endpoints.Structure;
+            const url = request ? basePath + toSearchParams(request) : basePath;
+            return yield this.fetchApi(url, "GET");
+        });
+    }
+    getPermissions(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.Permissions, "GET");
+        });
+    }
+    updatePermissions(id, request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.fetchApi((yield this.getModulePath()) + `/${id}` + Endpoints.Permissions, "PUT", JSON.stringify(request));
+        });
+    }
+}
+
 class PyrusApiClient extends BaseApi {
     constructor(auth, settings) {
         const currentSettings = !!settings
@@ -1046,6 +1115,11 @@ class PyrusApiClient extends BaseApi {
             this._bot = new BotApi(this.initParams);
         return this._bot;
     }
+    get knowledgeBase() {
+        if (!this._knowledgeBase)
+            this._knowledgeBase = new KnowledgeBaseApi(this.initParams);
+        return this._knowledgeBase;
+    }
 }
 
-export { ActivityAction, ApiError, ApprovalChoice, CallEventType, ErrorCodeType, FilterMask, Flag, FormFieldType, ListType, OperatorId, PermissionLevel, PersonRights, PersonType, PyrusApiClient, SendSmsError, SendSmsStatus, SourceType, fromJson, prepareHeadersForCatalogApiRequest, toDateString, toDateTimeString, toJson, toTimeString };
+export { ActivityAction, ApiError, ApprovalChoice, CallEventType, ErrorCodeType, FilterMask, Flag, FormFieldType, KnowledgeBaseEntityType, KnowledgeBasePermissionLevel, ListType, OperatorId, PermissionLevel, PersonRights, PersonType, PyrusApiClient, SendSmsError, SendSmsStatus, SourceType, fromJson, prepareHeadersForCatalogApiRequest, toDateString, toDateTimeString, toJson, toTimeString };

package/build/types/index.d.ts

@@ -165,6 +165,17 @@ declare module "pyrus-api" {
 			error: ErrorResponse;
 		});
 	}
+	export const KnowledgeBaseEntityType: {
+		readonly Article: "article";
+		readonly Topic: "topic";
+	};
+	export type KnowledgeBaseEntityType = typeof KnowledgeBaseEntityType[keyof typeof KnowledgeBaseEntityType];
+	export const KnowledgeBasePermissionLevel: {
+		readonly None: "none";
+		readonly Read: "read";
+		readonly Write: "write";
+	};
+	export type KnowledgeBasePermissionLevel = typeof KnowledgeBasePermissionLevel[keyof typeof KnowledgeBasePermissionLevel];
 	export const FilterMask: {
 		/**
 		 *  Events whose deadline is indicated in UTC+0
@@ -303,6 +314,74 @@ declare module "pyrus-api" {
 		readonly SendFailed: "send_failed";
 	};
 	export type SendSmsStatus = typeof SendSmsStatus[keyof typeof SendSmsStatus];
+	export type KnowledgeBasePersonInfo = {
+		id: number;
+		first_name: string;
+		last_name: string;
+		email: string;
+		type: string;
+	};
+	export type KnowledgeBaseStructureItem = {
+		id: string;
+		title: string;
+		type: KnowledgeBaseEntityType;
+		parent_topic_id: string;
+		created_at: Date;
+		updated_at: Date;
+		access_right: KnowledgeBasePermissionLevel;
+		is_open_for_organization: boolean;
+		children: KnowledgeBaseStructureItem[];
+	};
+	export type CreateKnowledgeBaseEntityRequest = {
+		type: KnowledgeBaseEntityType;
+		title: string;
+		body?: string;
+		parent_topic_id?: string;
+	};
+	export type UpdateKnowledgeBaseEntityRequest = {
+		title?: string;
+		body?: string;
+		parent_topic_id_changed?: boolean;
+		parent_topic_id?: string;
+	};
+	export type UpdateKnowledgeBasePermissionsRequest = {
+		inherit?: boolean;
+		readers?: number[];
+		editors?: number[];
+	};
+	export type GetKnowledgeBaseStructureRequest = {
+		parent_topic_id?: string;
+		depth?: number;
+	};
+	export type KnowledgeBaseEntityResponse = {
+		id: string;
+		title: string;
+		type: KnowledgeBaseEntityType;
+		body: string;
+		parent_topic_id: string;
+		author: KnowledgeBasePersonInfo;
+		created_at: Date;
+		updated_at: Date;
+		last_edited_by: KnowledgeBasePersonInfo;
+		version: number;
+		access_right: KnowledgeBasePermissionLevel;
+		is_open_for_organization: boolean;
+		is_public: boolean;
+	};
+	export type KnowledgeBaseDeleteResponse = {
+		deleted: boolean;
+	};
+	export type KnowledgeBaseStructureResponse = {
+		parent_topic_id?: string;
+		depth?: number;
+		items: KnowledgeBaseStructureItem[];
+	};
+	export type KnowledgeBasePermissionsResponse = {
+		global_permission: KnowledgeBasePermissionLevel;
+		inherit: boolean;
+		readers: KnowledgeBasePersonInfo[];
+		editors: KnowledgeBasePersonInfo[];
+	};
 	export type NewFile = {
 		guid?: string;
 		root_id?: number;
@@ -834,7 +913,10 @@ declare module "pyrus-api" {
 		Integrations = "/integrations",
 		Call = "/call",
 		AttachCallRecord = "/attachcallrecord",
-		Bots = "/bots"
+		Bots = "/bots",
+		KnowledgeBase = "/knowledgebase",
+		Structure = "/structure",
+		Permissions = "/permissions"
 	}
 	export type RolesResponse = {
 		roles: Role[];
@@ -1428,6 +1510,16 @@ declare module "pyrus-api" {
 		update(request: UpdateBotRequest): Promise<Bot>;
 		delete(request: DeleteBotRequest): Promise<Bot>;
 	}
+	class KnowledgeBaseApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		get(id: string): Promise<KnowledgeBaseEntityResponse>;
+		create(request: CreateKnowledgeBaseEntityRequest): Promise<KnowledgeBaseEntityResponse>;
+		update(id: string, request: UpdateKnowledgeBaseEntityRequest): Promise<KnowledgeBaseEntityResponse>;
+		delete(id: string, deleteWithChildren?: boolean): Promise<KnowledgeBaseDeleteResponse>;
+		getStructure(request?: GetKnowledgeBaseStructureRequest): Promise<KnowledgeBaseStructureResponse>;
+		getPermissions(id: string): Promise<KnowledgeBasePermissionsResponse>;
+		updatePermissions(id: string, request: UpdateKnowledgeBasePermissionsRequest): Promise<KnowledgeBasePermissionsResponse>;
+	}
 	export class PyrusApiClient extends BaseApi {
 		private _role;
 		private _profile;
@@ -1443,6 +1535,7 @@ declare module "pyrus-api" {
 		private _logs;
 		private _call;
 		private _bot;
+		private _knowledgeBase;
 		/**
 		 *
 		 * @param auth
@@ -1468,6 +1561,7 @@ declare module "pyrus-api" {
 		get logs(): LogsApi;
 		get call(): CallApi;
 		get bot(): BotApi;
+		get knowledgeBase(): KnowledgeBaseApi;
 	}
 	
 	export {};

package/package.json

@@ -1,7 +1,12 @@
 {
     "name": "pyrus-api",
-    "version": "3.3.2",
     "description": "Pyrus API client for TypeScript",
+    "version": "3.4.0",
+    "author": {
+        "name": "Pyrus",
+        "email": "contact@pyrus.com"
+    },
+    "license": "MIT",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/simplygoodsoftware/pyrusapi-typescript.git"
@@ -23,13 +28,10 @@
     },
     "scripts": {
         "build": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript && dts-bundle-generator --project tsconfig.types.json --no-banner -o ./build/types/index.d.ts index.ts && node ./module-wrapper.js",
-        "check:version": "node .husky/check-version.mjs"
+        "tsc": "tsc --noEmit",
+        "check:version": "node .husky/check-version.mjs",
+        "test": "vitest"
     },
-    "author": {
-        "name": "Pyrus",
-        "email": "contact@pyrus.com"
-    },
-    "license": "MIT",
     "devDependencies": {
         "@rollup/plugin-typescript": "^11.1.6",
         "@types/node": "^22.5.4",
@@ -38,9 +40,11 @@
         "husky": "^9.1.6",
         "lint-staged": "^15.2.10",
         "prettier": "2.5.1",
-        "rollup": "^4.21.2",
+        "rollup": "4.59.0",
         "rollup-plugin-cleandir": "^3.0.0",
-        "rollup-plugin-typescript2": "^0.36.0"
+        "rollup-plugin-typescript2": "^0.36.0",
+        "typescript": "^5.9.3",
+        "vitest": "^4.0.18"
     },
     "lint-staged": {
         "**/*": "prettier --write --ignore-unknown"