pyrus-api 3.2.0 → 3.3.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Pyrus
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Pyrus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,293 +1,293 @@
-# PyrusAPI Client
-
-[![npm version](https://badge.fury.io/js/pyrus-api.svg)](https://badge.fury.io/js/pyrus-api)
-
-A TypeScript client for the Pyrus API.
-The full documentation for API can be found [here](https://pyrus.com/en/help/api/)
-
-## Getting Started
-
-* Install
-
-```
-npm install pyrus-api
-```
-
-* Import client
-
-```typescript
-import {PyrusApiClient} from "pyrus-api";
-```
-
-* Create and authenticate API client      
-
-```typescript
-const client = new PyrusApiClient(
-  {
-      login: "pyrus@login.com",
-      security_key: "security_key_from_profile"
-  }
-);
-```
-  
-## Forms
-
-* Get all form templates
-  
-```typescript
-const formsResponse = await client.forms.getAll();
-const forms = formsResponse.forms;
-```
-
-* Get tasks list by form template
-
-```typescript
-import {OperatorId, toDateString} from "pyrus-api";
-```
-  
-```typescript
-const maxDate = new Date("2024-01-12");
-const formId = 19963;
-const formRegisterResponse = await client.forms.getTasks(
-    formId,
-    {
-        filters: [
-            {
-                operator_id: OperatorId.Equals,
-                field_id: 6,
-                values: ['555']
-            },
-            {
-                operator_id: OperatorId.LessThan,
-                field_id: 4,
-                values: [toDateString(maxDate)]
-            }
-        ],
-        include_archived: "y"
-    }
-);
-const tasks = formRegisterResponse.tasks;
-```
-      
-## Tasks
-
-* Get task with all comments
-
-```typescript
-const taskResponse = await client.tasks.get({id: 2512});
-const task = taskResponse.task;
-```
-
-* Add task comment
-
-```typescript
-import type {FormFieldTable} from "pyrus-api";
-import {ApprovalChoice} from "pyrus-api";
-```
-
-```typescript
-const taskId = 2512;
-const fieldToAdd: FormFieldTable = {
-	id: 1,
-    type: FormFieldType.Table,
-    value: [
-        {
-            row_id: 15,
-            cells: [
-                {
-                    type: FormFieldType.Text,
-                    name: "Comment",
-                    value: "That's right"
-                }
-            ],
-			position: 1
-        }
-    ]
-};
-const taskResponse = await client.tasks.addComment(
-    taskId,
-    {
-        approval_choice: ApprovalChoice.Approved,
-        field_updates: [fieldToAdd]
-    }
-);
-const task = taskResponse.task;
-```
-
-* Create a task
-  
-```typescript
-const taskResponse = await client.tasks.create(
-    {
-        text: "Help me",
-        participants: [
-            {id: 1731},
-            {email: "Amanda.Smith@gmail.com"}
-        ],
-        due_date: new Date("2024-11-03")
-    }
-);
-const task = taskResponse.task;
-```
-
-## Files
-
-* Upload a file
-
-```typescript
-const file = await fs.openAsBlob("C:\\path\\to\\file");
-const fileResponse = await client.files.upload(file, "filename");
-const fileId = fileResponse.guid;
-```
-
-## Catalogs
-
-* Get catalog with all items
-
-```typescript
-const catalogResponse = await client.catalogs.get({id: 1525});
-const items = catalogResponse.items;
-```
-
-* Create catalog
-
-```typescript
-const catalogResponse = await client.catalogs.create(
-    {
-        name: "NewCatalog",
-        catalog_headers: ["Header1", "Header2"],
-        items: [
-            {values: ["A1", "A2"]},
-            {values: ["B1", "B2"]}
-        ]
-    }
-);
-const catalogId = catalogResponse.catalog_id;
-```
-
-* Sync catalog (All unspecified catalog items and text columns will be deleted)
-
-```typescript
-const catalogResponse = await client.catalogs.sync(
-    {
-        id: 1236,
-        apply: true,
-
-        catalog_headers: ["Header1", "Header3"],
-        items: [
-            {values: ["A1", "A3"]},
-            {values: ["C1", "C2"]}
-        ]
-    }
-);
-```
-
-## Contacts
-
-* Get all available contacts
-
-```typescript
-const contactsResponse = await client.contacts.getAll();
-```
-
-## Lists
-
-* Get all lists
-
-```typescript
-const listsResponse = await client.lists.getAll();
-```
-
-* Get all tasks in list
-
-```typescript
-const listId = 1322;
-const listsResponse = await client.lists.getTasksInList(listId);
-```
-
-## Roles
-
-* Get all organization roles
-
-```typescript
-const rolesResponse = await client.role.getAll();
-```
-
-* Create role
-
-```typescript
-const roleResponse = await client.role.create(
-    {
-        name: "TechSupport",
-        member_add: [1732, 4368]
-    }
-);
-```
-
-* Update role
-
-```typescript
-const roleResponse = await client.role.update(
-    {
-        id: 6476,
-        member_add: [2434],
-        member_remove: [1732, 4368],
-        external_id: "CustomIdentifier"
-    }
-);
-```
-
-## Profile
-
-* Get profile
-
-```typescript
-const profileResponse = await client.profile.get();
-```
-
-
-## Inbox
-
-* Get inbox
-
-```typescript
-const inboxResponse = await client.lists.getInbox({item_count: 10});
-```
-
-## Announcements
-
-* Get announcement with all comments
-
-```typescript
-const announcementResponse = await client.announcements.get({id: 15353});
-const announcement = announcementResponse.announcement;
-```
-
-* Get announcements with all comments
-
-```typescript
-const announcementsResponse = await client.announcements.getAll();
-const announcements = announcementsResponse.announcements;
-```
-
-* Add announcement comment
-
-```typescript
-const announcementId = 15353;
-const announcementResponse = await client.announcements.addComment(
-    announcementId,
-    {
-        text: "SomeText"
-    }
-);
-```
-
-* Create an announcement
-  
-```typescript
-const announcementResponse = await client.announcements.create(
-    {
-        text: "New announcement"
-    }
-);
+# PyrusAPI Client
+
+[![npm version](https://badge.fury.io/js/pyrus-api.svg)](https://badge.fury.io/js/pyrus-api)
+
+A TypeScript client for the Pyrus API.
+The full documentation for API can be found [here](https://pyrus.com/en/help/api/)
+
+## Getting Started
+
+* Install
+
+```
+npm install pyrus-api
+```
+
+* Import client
+
+```typescript
+import {PyrusApiClient} from "pyrus-api";
+```
+
+* Create and authenticate API client      
+
+```typescript
+const client = new PyrusApiClient(
+  {
+      login: "pyrus@login.com",
+      security_key: "security_key_from_profile"
+  }
+);
+```
+  
+## Forms
+
+* Get all form templates
+  
+```typescript
+const formsResponse = await client.forms.getAll();
+const forms = formsResponse.forms;
+```
+
+* Get tasks list by form template
+
+```typescript
+import {OperatorId, toDateString} from "pyrus-api";
+```
+  
+```typescript
+const maxDate = new Date("2024-01-12");
+const formId = 19963;
+const formRegisterResponse = await client.forms.getTasks(
+    formId,
+    {
+        filters: [
+            {
+                operator_id: OperatorId.Equals,
+                field_id: 6,
+                values: ['555']
+            },
+            {
+                operator_id: OperatorId.LessThan,
+                field_id: 4,
+                values: [toDateString(maxDate)]
+            }
+        ],
+        include_archived: "y"
+    }
+);
+const tasks = formRegisterResponse.tasks;
+```
+      
+## Tasks
+
+* Get task with all comments
+
+```typescript
+const taskResponse = await client.tasks.get({id: 2512});
+const task = taskResponse.task;
+```
+
+* Add task comment
+
+```typescript
+import type {FormFieldTable} from "pyrus-api";
+import {ApprovalChoice} from "pyrus-api";
+```
+
+```typescript
+const taskId = 2512;
+const fieldToAdd: FormFieldTable = {
+	id: 1,
+    type: FormFieldType.Table,
+    value: [
+        {
+            row_id: 15,
+            cells: [
+                {
+                    type: FormFieldType.Text,
+                    name: "Comment",
+                    value: "That's right"
+                }
+            ],
+			position: 1
+        }
+    ]
+};
+const taskResponse = await client.tasks.addComment(
+    taskId,
+    {
+        approval_choice: ApprovalChoice.Approved,
+        field_updates: [fieldToAdd]
+    }
+);
+const task = taskResponse.task;
+```
+
+* Create a task
+  
+```typescript
+const taskResponse = await client.tasks.create(
+    {
+        text: "Help me",
+        participants: [
+            {id: 1731},
+            {email: "Amanda.Smith@gmail.com"}
+        ],
+        due_date: new Date("2024-11-03")
+    }
+);
+const task = taskResponse.task;
+```
+
+## Files
+
+* Upload a file
+
+```typescript
+const file = await fs.openAsBlob("C:\\path\\to\\file");
+const fileResponse = await client.files.upload(file, "filename");
+const fileId = fileResponse.guid;
+```
+
+## Catalogs
+
+* Get catalog with all items
+
+```typescript
+const catalogResponse = await client.catalogs.get({id: 1525});
+const items = catalogResponse.items;
+```
+
+* Create catalog
+
+```typescript
+const catalogResponse = await client.catalogs.create(
+    {
+        name: "NewCatalog",
+        catalog_headers: ["Header1", "Header2"],
+        items: [
+            {values: ["A1", "A2"]},
+            {values: ["B1", "B2"]}
+        ]
+    }
+);
+const catalogId = catalogResponse.catalog_id;
+```
+
+* Sync catalog (All unspecified catalog items and text columns will be deleted)
+
+```typescript
+const catalogResponse = await client.catalogs.sync(
+    {
+        id: 1236,
+        apply: true,
+
+        catalog_headers: ["Header1", "Header3"],
+        items: [
+            {values: ["A1", "A3"]},
+            {values: ["C1", "C2"]}
+        ]
+    }
+);
+```
+
+## Contacts
+
+* Get all available contacts
+
+```typescript
+const contactsResponse = await client.contacts.getAll();
+```
+
+## Lists
+
+* Get all lists
+
+```typescript
+const listsResponse = await client.lists.getAll();
+```
+
+* Get all tasks in list
+
+```typescript
+const listId = 1322;
+const listsResponse = await client.lists.getTasksInList(listId);
+```
+
+## Roles
+
+* Get all organization roles
+
+```typescript
+const rolesResponse = await client.role.getAll();
+```
+
+* Create role
+
+```typescript
+const roleResponse = await client.role.create(
+    {
+        name: "TechSupport",
+        member_add: [1732, 4368]
+    }
+);
+```
+
+* Update role
+
+```typescript
+const roleResponse = await client.role.update(
+    {
+        id: 6476,
+        member_add: [2434],
+        member_remove: [1732, 4368],
+        external_id: "CustomIdentifier"
+    }
+);
+```
+
+## Profile
+
+* Get profile
+
+```typescript
+const profileResponse = await client.profile.get();
+```
+
+
+## Inbox
+
+* Get inbox
+
+```typescript
+const inboxResponse = await client.lists.getInbox({item_count: 10});
+```
+
+## Announcements
+
+* Get announcement with all comments
+
+```typescript
+const announcementResponse = await client.announcements.get({id: 15353});
+const announcement = announcementResponse.announcement;
+```
+
+* Get announcements with all comments
+
+```typescript
+const announcementsResponse = await client.announcements.getAll();
+const announcements = announcementsResponse.announcements;
+```
+
+* Add announcement comment
+
+```typescript
+const announcementId = 15353;
+const announcementResponse = await client.announcements.addComment(
+    announcementId,
+    {
+        text: "SomeText"
+    }
+);
+```
+
+* Create an announcement
+  
+```typescript
+const announcementResponse = await client.announcements.create(
+    {
+        text: "New announcement"
+    }
+);
 ```

package/build/types/index.d.ts

@@ -398,10 +398,10 @@ declare module "pyrus-api" {
 	};
 	export type FormFieldCatalog = FormFieldBase & {
 		type?: typeof FormFieldType.Catalog;
-		value?: Catalog;
+		value?: CatalogValue;
 	};
-	export type Catalog = {
-		item_id: number;
+	export type CatalogValue = {
+		item_id?: number;
 		item_ids?: number[];
 		item_names?: string[];
 		headers?: string[];
@@ -475,7 +475,7 @@ declare module "pyrus-api" {
 		choice_id?: number;
 		choice_ids?: number[];
 		choice_names?: string[];
-		fields?: FormField[];
+		fields?: FormFieldCommon[];
 	};
 	export type FormFieldNewFile = FormFieldFile & {
 		value?: NewFile[];
@@ -527,7 +527,7 @@ declare module "pyrus-api" {
 	};
 	export type TableRow = {
 		row_id: number;
-		cells?: FormField[];
+		cells?: FormFieldCommon[];
 		delete?: boolean;
 		deleted?: boolean;
 		position?: number;
@@ -546,7 +546,7 @@ declare module "pyrus-api" {
 	};
 	export type Title = {
 		checkmark?: Checkmark;
-		fields?: FormField[];
+		fields?: FormFieldCommon[];
 	};
 	export type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE";
 	export type IdRequired = {
@@ -555,11 +555,15 @@ declare module "pyrus-api" {
 	export type CodeRequired = {
 		code: string;
 	};
+	export type NameRequired = {
+		name: string;
+	};
 	export type ById = IdRequired;
-	export type IdOrCodeRequired = IdRequired | CodeRequired;
+	export type FormFieldIdentifier = IdRequired | CodeRequired | NameRequired;
 	export type FormFieldCommon = FormFieldAuthor | FormFieldCatalog | FormFieldCheckmark | FormFieldCreateDate | FormFieldDate | FormFieldDueDate | FormFieldDueDateTime | FormFieldEmail | FormFieldFile | FormFieldFlag | FormFieldFormLink | FormFieldMoney | FormFieldMultipleChoice | FormFieldNewFile | FormFieldNote | FormFieldNumber | FormFieldPerson | FormFieldPhone | FormFieldProject | FormFieldStatus | FormFieldStep | FormFieldTable | FormFieldText | FormFieldTime | FormFieldTitle;
-	export type FormField = FormFieldCommon & IdRequired;
-	export type FormFieldIdentified = FormFieldCommon & IdOrCodeRequired;
+	export type IdAndNameRequired = IdRequired & NameRequired;
+	export type FormField = FormFieldCommon & IdAndNameRequired;
+	export type FormFieldIdentified = FormFieldCommon & FormFieldIdentifier;
 	const ChannelType: {
 		readonly Email: "email";
 		readonly Telegram: "telegram";
@@ -632,6 +636,7 @@ declare module "pyrus-api" {
 		skip_satisfaction?: boolean;
 		edit_comment_id?: number;
 		skip_notification?: boolean;
+		skip_auto_reopen?: boolean;
 	};
 	export type CommentDescription = {
 		task_id: number;

package/package.json

@@ -1,48 +1,48 @@
-{
-    "name": "pyrus-api",
-    "version": "3.2.0",
-    "description": "Pyrus API client for TypeScript",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/simplygoodsoftware/pyrusapi-typescript.git"
-    },
-    "type": "module",
-    "main": "./build/cjs/index.js",
-    "module": "./build/esm/index.js",
-    "types": "./build/types/index.d.ts",
-    "exports": {
-        "require": {
-            "default": "./build/cjs/index.cjs"
-        },
-        "import": {
-            "default": "./build/esm/index.js"
-        },
-        "types": {
-            "default": "./build/types/index.d.ts"
-        }
-    },
-    "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",
-        "prepare": "husky"
-    },
-    "author": {
-        "name": "Pyrus",
-        "email": "contact@pyrus.com"
-    },
-    "license": "MIT",
-    "devDependencies": {
-        "@rollup/plugin-typescript": "^11.1.6",
-        "@types/node": "^22.5.4",
-        "@types/rollup": "^0.54.0",
-        "dts-bundle-generator": "^9.5.1",
-        "husky": "^9.1.6",
-        "lint-staged": "^15.2.10",
-        "prettier": "2.5.1",
-        "rollup": "^4.21.2",
-        "rollup-plugin-cleandir": "^3.0.0",
-        "rollup-plugin-typescript2": "^0.36.0"
-    },
-    "lint-staged": {
-        "**/*": "prettier --write --ignore-unknown"
-    }
-}
+{
+    "name": "pyrus-api",
+    "version": "3.3.1",
+    "description": "Pyrus API client for TypeScript",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/simplygoodsoftware/pyrusapi-typescript.git"
+    },
+    "type": "module",
+    "main": "./build/cjs/index.js",
+    "module": "./build/esm/index.js",
+    "types": "./build/types/index.d.ts",
+    "exports": {
+        "require": {
+            "default": "./build/cjs/index.cjs"
+        },
+        "import": {
+            "default": "./build/esm/index.js"
+        },
+        "types": {
+            "default": "./build/types/index.d.ts"
+        }
+    },
+    "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"
+    },
+    "author": {
+        "name": "Pyrus",
+        "email": "contact@pyrus.com"
+    },
+    "license": "MIT",
+    "devDependencies": {
+        "@rollup/plugin-typescript": "^11.1.6",
+        "@types/node": "^22.5.4",
+        "@types/rollup": "^0.54.0",
+        "dts-bundle-generator": "^9.5.1",
+        "husky": "^9.1.6",
+        "lint-staged": "^15.2.10",
+        "prettier": "2.5.1",
+        "rollup": "^4.21.2",
+        "rollup-plugin-cleandir": "^3.0.0",
+        "rollup-plugin-typescript2": "^0.36.0"
+    },
+    "lint-staged": {
+        "**/*": "prettier --write --ignore-unknown"
+    }
+}