pyrus-api 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. package/LICENSE.txt +21 -0
  2. package/README.md +289 -0
  3. package/build/cjs/index.js +1015 -0
  4. package/build/esm/index.js +1010 -0
  5. package/build/types/index.d.ts +51 -0
  6. package/build/types/src/api/announcementsApi.d.ts +14 -0
  7. package/build/types/src/api/baseApi.d.ts +21 -0
  8. package/build/types/src/api/botApi.d.ts +17 -0
  9. package/build/types/src/api/calendarApi.d.ts +8 -0
  10. package/build/types/src/api/callApi.d.ts +11 -0
  11. package/build/types/src/api/catalogsApi.d.ts +22 -0
  12. package/build/types/src/api/contactsApi.d.ts +8 -0
  13. package/build/types/src/api/filesApi.d.ts +8 -0
  14. package/build/types/src/api/formsApi.d.ts +17 -0
  15. package/build/types/src/api/index.d.ts +1 -0
  16. package/build/types/src/api/listsApi.d.ts +20 -0
  17. package/build/types/src/api/logsApi.d.ts +13 -0
  18. package/build/types/src/api/membersApi.d.ts +21 -0
  19. package/build/types/src/api/profileApi.d.ts +8 -0
  20. package/build/types/src/api/pyrusApiClient.d.ts +57 -0
  21. package/build/types/src/api/roleApi.d.ts +15 -0
  22. package/build/types/src/api/tasksApi.d.ts +18 -0
  23. package/build/types/src/entities/TaskWithComments.d.ts +7 -0
  24. package/build/types/src/entities/announcementComment.d.ts +12 -0
  25. package/build/types/src/entities/announcementWithComments.d.ts +13 -0
  26. package/build/types/src/entities/approval.d.ts +7 -0
  27. package/build/types/src/entities/attachedFile.d.ts +9 -0
  28. package/build/types/src/entities/bot.d.ts +15 -0
  29. package/build/types/src/entities/catalogHeader.d.ts +9 -0
  30. package/build/types/src/entities/catalogInfo.d.ts +19 -0
  31. package/build/types/src/entities/catalogItem.d.ts +12 -0
  32. package/build/types/src/entities/channel.d.ts +8 -0
  33. package/build/types/src/entities/channelUser.d.ts +4 -0
  34. package/build/types/src/entities/columnSettings.d.ts +6 -0
  35. package/build/types/src/entities/commentDescription.d.ts +6 -0
  36. package/build/types/src/entities/department.d.ts +7 -0
  37. package/build/types/src/entities/dueFilter.d.ts +3 -0
  38. package/build/types/src/entities/formFieldInfo.d.ts +21 -0
  39. package/build/types/src/entities/formFields/formField.d.ts +26 -0
  40. package/build/types/src/entities/formFields/formFieldAuthor.d.ts +7 -0
  41. package/build/types/src/entities/formFields/formFieldBase.d.ts +12 -0
  42. package/build/types/src/entities/formFields/formFieldCatalog.d.ts +15 -0
  43. package/build/types/src/entities/formFields/formFieldCheckmark.d.ts +7 -0
  44. package/build/types/src/entities/formFields/formFieldCreateDate.d.ts +6 -0
  45. package/build/types/src/entities/formFields/formFieldDate.d.ts +6 -0
  46. package/build/types/src/entities/formFields/formFieldDueDate.d.ts +6 -0
  47. package/build/types/src/entities/formFields/formFieldDueDateTime.d.ts +6 -0
  48. package/build/types/src/entities/formFields/formFieldEmail.d.ts +6 -0
  49. package/build/types/src/entities/formFields/formFieldFile.d.ts +7 -0
  50. package/build/types/src/entities/formFields/formFieldFlag.d.ts +7 -0
  51. package/build/types/src/entities/formFields/formFieldFormLink.d.ts +7 -0
  52. package/build/types/src/entities/formFields/formFieldMoney.d.ts +6 -0
  53. package/build/types/src/entities/formFields/formFieldMultipleChoice.d.ts +14 -0
  54. package/build/types/src/entities/formFields/formFieldNewFile.d.ts +5 -0
  55. package/build/types/src/entities/formFields/formFieldNote.d.ts +6 -0
  56. package/build/types/src/entities/formFields/formFieldNumber.d.ts +6 -0
  57. package/build/types/src/entities/formFields/formFieldPerson.d.ts +7 -0
  58. package/build/types/src/entities/formFields/formFieldPhone.d.ts +6 -0
  59. package/build/types/src/entities/formFields/formFieldProject.d.ts +15 -0
  60. package/build/types/src/entities/formFields/formFieldStatus.d.ts +7 -0
  61. package/build/types/src/entities/formFields/formFieldStep.d.ts +6 -0
  62. package/build/types/src/entities/formFields/formFieldTable.d.ts +14 -0
  63. package/build/types/src/entities/formFields/formFieldText.d.ts +6 -0
  64. package/build/types/src/entities/formFields/formFieldTime.d.ts +6 -0
  65. package/build/types/src/entities/formFields/formFieldTitle.d.ts +13 -0
  66. package/build/types/src/entities/formLink.d.ts +5 -0
  67. package/build/types/src/entities/formMapping.d.ts +16 -0
  68. package/build/types/src/entities/newFile.d.ts +7 -0
  69. package/build/types/src/entities/organization.d.ts +9 -0
  70. package/build/types/src/entities/person.d.ts +19 -0
  71. package/build/types/src/entities/plainTaskList.d.ts +15 -0
  72. package/build/types/src/entities/printForm.d.ts +4 -0
  73. package/build/types/src/entities/role.d.ts +10 -0
  74. package/build/types/src/entities/sessionLifespan.d.ts +4 -0
  75. package/build/types/src/entities/sessionRestriction.d.ts +9 -0
  76. package/build/types/src/entities/settings.d.ts +5 -0
  77. package/build/types/src/entities/smsInfo.d.ts +8 -0
  78. package/build/types/src/entities/step.d.ts +5 -0
  79. package/build/types/src/entities/subscriber.d.ts +6 -0
  80. package/build/types/src/entities/task.d.ts +26 -0
  81. package/build/types/src/entities/taskComment.d.ts +50 -0
  82. package/build/types/src/entities/taskHeader.d.ts +11 -0
  83. package/build/types/src/entities/taskList.d.ts +4 -0
  84. package/build/types/src/enums/activityAction.d.ts +4 -0
  85. package/build/types/src/enums/approvalChoice.d.ts +7 -0
  86. package/build/types/src/enums/callEventType.d.ts +3 -0
  87. package/build/types/src/enums/callStatus.d.ts +7 -0
  88. package/build/types/src/enums/channelType.d.ts +23 -0
  89. package/build/types/src/enums/checkmark.d.ts +4 -0
  90. package/build/types/src/enums/disconnectParty.d.ts +6 -0
  91. package/build/types/src/enums/errorCodeType.d.ts +123 -0
  92. package/build/types/src/enums/filterMask.d.ts +20 -0
  93. package/build/types/src/enums/flag.d.ts +5 -0
  94. package/build/types/src/enums/formFieldType.d.ts +27 -0
  95. package/build/types/src/enums/listType.d.ts +4 -0
  96. package/build/types/src/enums/operatorId.d.ts +9 -0
  97. package/build/types/src/enums/permissionLevel.d.ts +6 -0
  98. package/build/types/src/enums/personRights.d.ts +24 -0
  99. package/build/types/src/enums/personType.d.ts +5 -0
  100. package/build/types/src/enums/sendSmsError.d.ts +11 -0
  101. package/build/types/src/enums/sendSmsStatus.d.ts +6 -0
  102. package/build/types/src/enums/sourceType.d.ts +4 -0
  103. package/build/types/src/enums/status.d.ts +4 -0
  104. package/build/types/src/helpers/constants.d.ts +8 -0
  105. package/build/types/src/helpers/functions.d.ts +13 -0
  106. package/build/types/src/helpers/types.d.ts +4 -0
  107. package/build/types/src/requests/announcementCommentRequest.d.ts +6 -0
  108. package/build/types/src/requests/announcementRequest.d.ts +6 -0
  109. package/build/types/src/requests/attachCallRecordRequest.d.ts +37 -0
  110. package/build/types/src/requests/authRequest.d.ts +11 -0
  111. package/build/types/src/requests/calendarTasksRequest.d.ts +24 -0
  112. package/build/types/src/requests/callRequest.d.ts +27 -0
  113. package/build/types/src/requests/catalogRequestBase.d.ts +15 -0
  114. package/build/types/src/requests/changePermissionsRequest.d.ts +4 -0
  115. package/build/types/src/requests/contactsRequest.d.ts +3 -0
  116. package/build/types/src/requests/createBotRequest.d.ts +5 -0
  117. package/build/types/src/requests/createCallRequest.d.ts +6 -0
  118. package/build/types/src/requests/createCatalogRequest.d.ts +6 -0
  119. package/build/types/src/requests/createDepartmentRequest.d.ts +6 -0
  120. package/build/types/src/requests/createListRequest.d.ts +12 -0
  121. package/build/types/src/requests/createMemberRequest.d.ts +12 -0
  122. package/build/types/src/requests/createRoleRequest.d.ts +5 -0
  123. package/build/types/src/requests/deleteBotRequest.d.ts +4 -0
  124. package/build/types/src/requests/deleteRoleRequest.d.ts +4 -0
  125. package/build/types/src/requests/formFilter.d.ts +6 -0
  126. package/build/types/src/requests/formRegisterRequest.d.ts +26 -0
  127. package/build/types/src/requests/getAllRequest.d.ts +3 -0
  128. package/build/types/src/requests/getMessageRequest.d.ts +10 -0
  129. package/build/types/src/requests/inboxRequest.d.ts +8 -0
  130. package/build/types/src/requests/personIdentity.d.ts +4 -0
  131. package/build/types/src/requests/profileRequest.d.ts +3 -0
  132. package/build/types/src/requests/setAvatarRequest.d.ts +4 -0
  133. package/build/types/src/requests/syncCatalogRequest.d.ts +6 -0
  134. package/build/types/src/requests/taskCommentRequest.d.ts +39 -0
  135. package/build/types/src/requests/taskListRequest.d.ts +10 -0
  136. package/build/types/src/requests/taskRequest.d.ts +24 -0
  137. package/build/types/src/requests/updateBotRequest.d.ts +13 -0
  138. package/build/types/src/requests/updateDepartmentRequest.d.ts +8 -0
  139. package/build/types/src/requests/updateListRequest.d.ts +14 -0
  140. package/build/types/src/requests/updateMemberRequest.d.ts +15 -0
  141. package/build/types/src/requests/updateRoleRequest.d.ts +8 -0
  142. package/build/types/src/responses/announcementResponse.d.ts +5 -0
  143. package/build/types/src/responses/announcementsResponse.d.ts +5 -0
  144. package/build/types/src/responses/authResponse.d.ts +6 -0
  145. package/build/types/src/responses/botResponse.d.ts +3 -0
  146. package/build/types/src/responses/botsResponse.d.ts +5 -0
  147. package/build/types/src/responses/calendarResponse.d.ts +6 -0
  148. package/build/types/src/responses/callResponse.d.ts +4 -0
  149. package/build/types/src/responses/catalogItemResponse.d.ts +4 -0
  150. package/build/types/src/responses/catalogResponse.d.ts +18 -0
  151. package/build/types/src/responses/contactsResponse.d.ts +5 -0
  152. package/build/types/src/responses/departmentResponse.d.ts +3 -0
  153. package/build/types/src/responses/departmentsResponse.d.ts +5 -0
  154. package/build/types/src/responses/formRegisterResponse.d.ts +5 -0
  155. package/build/types/src/responses/formResponse.d.ts +17 -0
  156. package/build/types/src/responses/formsResponse.d.ts +4 -0
  157. package/build/types/src/responses/listsResponse.d.ts +5 -0
  158. package/build/types/src/responses/memberResponse.d.ts +3 -0
  159. package/build/types/src/responses/membersResponse.d.ts +5 -0
  160. package/build/types/src/responses/permissionsDict.d.ts +4 -0
  161. package/build/types/src/responses/permissionsResponse.d.ts +5 -0
  162. package/build/types/src/responses/plainListResponse.d.ts +3 -0
  163. package/build/types/src/responses/profileIdentityResponse.d.ts +5 -0
  164. package/build/types/src/responses/profileResponse.d.ts +12 -0
  165. package/build/types/src/responses/responseBase.d.ts +6 -0
  166. package/build/types/src/responses/roleResponse.d.ts +3 -0
  167. package/build/types/src/responses/rolesResponse.d.ts +5 -0
  168. package/build/types/src/responses/syncCatalogResponse.d.ts +10 -0
  169. package/build/types/src/responses/taskListResponse.d.ts +6 -0
  170. package/build/types/src/responses/taskResponse.d.ts +5 -0
  171. package/build/types/src/responses/uploadResponse.d.ts +5 -0
  172. package/build/types/src/responses//321/201atalogsResponse.d.ts +5 -0
  173. package/build/types/src/settings/defaults.d.ts +2 -0
  174. package/build/types/src/settings/endpoints.d.ts +32 -0
  175. package/package.json +35 -0
@@ -0,0 +1,4 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ export type CallResponse = ResponseBase & {
3
+ task_id: number;
4
+ };
@@ -0,0 +1,4 @@
1
+ import { CatalogItem } from "../entities/catalogItem";
2
+ export type CatalogItemResponse = CatalogItem & {
3
+ item_id: number;
4
+ };
@@ -0,0 +1,18 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { CatalogHeader } from "../entities/catalogHeader";
3
+ import { ColumnSettings } from "../entities/columnSettings";
4
+ import { SourceType } from "../enums/sourceType";
5
+ import { CatalogItemResponse } from "./catalogItemResponse";
6
+ export type CatalogResponse = ResponseBase & {
7
+ catalog_id: number;
8
+ name: string;
9
+ external_id?: string;
10
+ version: number;
11
+ external_version?: number;
12
+ deleted: boolean;
13
+ supervisors?: number[];
14
+ catalog_headers: CatalogHeader[];
15
+ column_settings?: ColumnSettings[];
16
+ items?: CatalogItemResponse[];
17
+ source_type: SourceType;
18
+ };
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Organization } from "../entities/organization";
3
+ export type ContactsResponse = ResponseBase & {
4
+ organizations: Organization[];
5
+ };
@@ -0,0 +1,3 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Department } from "../entities/department";
3
+ export type DepartmentResponse = ResponseBase & Department;
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Department } from "../entities/department";
3
+ export type DepartmentsResponse = ResponseBase & {
4
+ departments: Department[];
5
+ };
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Task } from "../entities/task";
3
+ export type FormRegisterResponse = ResponseBase & {
4
+ tasks: Task[];
5
+ };
@@ -0,0 +1,17 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { FormField } from "../entities/formFields/formField";
3
+ import { PrintForm } from "../entities/printForm";
4
+ export type FormResponse = ResponseBase & {
5
+ id: number;
6
+ name: string;
7
+ steps?: TaskSteps;
8
+ fields: FormField[];
9
+ print_forms?: PrintForm[];
10
+ deleted_or_closed: boolean;
11
+ business_owners?: number[];
12
+ folder?: string[];
13
+ };
14
+ type TaskSteps = {
15
+ [index: number]: string;
16
+ };
17
+ export {};
@@ -0,0 +1,4 @@
1
+ import { FormResponse } from "./formResponse";
2
+ export type FormsResponse = {
3
+ forms: FormResponse[];
4
+ };
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { TaskList } from "../entities/taskList";
3
+ export type ListsResponse = ResponseBase & {
4
+ lists: TaskList[];
5
+ };
@@ -0,0 +1,3 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Person } from "../entities/person";
3
+ export type MemberResponse = ResponseBase & Person;
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Person } from "../entities/person";
3
+ export type MembersResponse = ResponseBase & {
4
+ members: Person[];
5
+ };
@@ -0,0 +1,4 @@
1
+ import { PermissionLevel } from "../enums/permissionLevel";
2
+ export type PermissionsDict = {
3
+ [index: string | number]: PermissionLevel;
4
+ };
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { PermissionsDict } from "./permissionsDict";
3
+ export type PermissionsResponse = ResponseBase & {
4
+ permissions: PermissionsDict;
5
+ };
@@ -0,0 +1,3 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { PlainTaskList } from "../entities/plainTaskList";
3
+ export type PlainListResponse = ResponseBase & PlainTaskList;
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ export type ProfileIdentityResponse = ResponseBase & {
3
+ email: string;
4
+ organization_id: number;
5
+ };
@@ -0,0 +1,12 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Organization } from "../entities/organization";
3
+ export type ProfileResponse = ResponseBase & {
4
+ person_id: number;
5
+ first_name?: string;
6
+ last_name?: string;
7
+ email: string;
8
+ locale?: string;
9
+ organization_id: number;
10
+ organization: Organization;
11
+ timezone_offset?: number;
12
+ };
@@ -0,0 +1,6 @@
1
+ import { ErrorCodeType } from "../enums/errorCodeType";
2
+ export type ResponseBase = {
3
+ error?: string;
4
+ error_code?: ErrorCodeType;
5
+ error_message?: string;
6
+ };
@@ -0,0 +1,3 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Role } from "../entities/role";
3
+ export type RoleResponse = ResponseBase & Role;
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { Role } from "../entities/role";
3
+ export type RolesResponse = ResponseBase & {
4
+ roles: Role[];
5
+ };
@@ -0,0 +1,10 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { CatalogHeader } from "../entities/catalogHeader";
3
+ import { CatalogItemResponse } from "./catalogItemResponse";
4
+ export type SyncCatalogResponse = ResponseBase & {
5
+ apply: boolean;
6
+ added?: CatalogItemResponse[];
7
+ deleted?: CatalogItemResponse[];
8
+ updated?: CatalogItemResponse[];
9
+ catalog_headers: CatalogHeader[];
10
+ };
@@ -0,0 +1,6 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { TaskHeader } from "../entities/taskHeader";
3
+ export type TaskListResponse = ResponseBase & {
4
+ tasks: TaskHeader[];
5
+ has_more: boolean;
6
+ };
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { TaskWithComments } from "../entities/TaskWithComments";
3
+ export type TaskResponse = ResponseBase & {
4
+ task: TaskWithComments;
5
+ };
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ export type UploadResponse = ResponseBase & {
3
+ guid: string;
4
+ md5_hash: string;
5
+ };
@@ -0,0 +1,5 @@
1
+ import { ResponseBase } from "./responseBase";
2
+ import { CatalogInfo } from "../entities/catalogInfo";
3
+ export type CatalogsResponse = ResponseBase & {
4
+ catalogs: CatalogInfo[];
5
+ };
@@ -0,0 +1,2 @@
1
+ import { Settings } from "../entities/settings";
2
+ export declare const defaults: Settings;
@@ -0,0 +1,32 @@
1
+ export declare enum Endpoints {
2
+ Auth = "/auth",
3
+ Roles = "/roles",
4
+ Profile = "/profile",
5
+ Contacts = "/contacts",
6
+ Files = "/files",
7
+ V4 = "/v4",
8
+ Upload = "/upload",
9
+ Download = "/download",
10
+ Lists = "/lists",
11
+ Inbox = "/inbox",
12
+ ListTasks = "/tasks",
13
+ Calendar = "/calendar",
14
+ Announcements = "/announcements",
15
+ AnnouncementComments = "/comments",
16
+ Catalogs = "/catalogs",
17
+ Members = "/members",
18
+ Tasks = "/tasks",
19
+ TasksComments = "/comments",
20
+ Forms = "/forms",
21
+ FormsRegister = "/register",
22
+ FormsPermissions = "/permissions",
23
+ EventHistory = "/eventhistory",
24
+ FileAccessHistory = "/fileaccesshistory",
25
+ TaskAccessHistory = "/taskaccesshistory",
26
+ TaskExportHistory = "/taskexporthistory",
27
+ RegistryDownloadHistory = "/registrydownloadhistory",
28
+ Integrations = "/integrations",
29
+ Call = "/call",
30
+ AttachCallRecord = "/attachcallrecord",
31
+ Bots = "/bots"
32
+ }
package/package.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "name": "pyrus-api",
3
+ "version": "1.0.0",
4
+ "description": "Pyrus API client for TypeScript",
5
+ "type": "module",
6
+ "main": "./build/cjs/index.js",
7
+ "module": "./build/esm/index.js",
8
+ "types": "./build/types/index.d.ts",
9
+ "exports": {
10
+ "require": {
11
+ "default": "./build/cjs/index.js"
12
+ },
13
+ "import": {
14
+ "default": "./build/esm/index.js"
15
+ },
16
+ "types": {
17
+ "default": "./build/types/index.d.ts"
18
+ }
19
+ },
20
+ "scripts": {
21
+ "build": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript && tsc --declaration --emitDeclarationOnly "
22
+ },
23
+ "author": {
24
+ "name": "Pyrus",
25
+ "email": "contact@pyrus.com"
26
+ },
27
+ "license": "MIT",
28
+ "devDependencies": {
29
+ "@rollup/plugin-typescript": "^11.1.6",
30
+ "@types/node": "^22.5.4",
31
+ "@types/rollup": "^0.54.0",
32
+ "rollup": "^4.21.2",
33
+ "rollup-plugin-typescript2": "^0.36.0"
34
+ }
35
+ }