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,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldDueDate = FormFieldBase & {
4
+ type?: FormFieldType.DueDate;
5
+ value?: Date;
6
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldDueDateTime = FormFieldBase & {
4
+ type?: FormFieldType.DueDateTime;
5
+ value?: Date;
6
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldEmail = FormFieldBase & {
4
+ type?: FormFieldType.Email;
5
+ value?: string;
6
+ };
@@ -0,0 +1,7 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { AttachedFile } from "../attachedFile";
4
+ export type FormFieldFile = FormFieldBase & {
5
+ type?: FormFieldType.File;
6
+ value?: AttachedFile[];
7
+ };
@@ -0,0 +1,7 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { Flag } from "../../enums/flag";
4
+ export type FormFieldFlag = FormFieldBase & {
5
+ type?: FormFieldType.Flag;
6
+ value?: Flag;
7
+ };
@@ -0,0 +1,7 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { FormLink } from "../formLink";
4
+ export type FormFieldFormLink = FormFieldBase & {
5
+ type?: FormFieldType.FormLink;
6
+ value?: FormLink;
7
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldMoney = FormFieldBase & {
4
+ type?: FormFieldType.Money;
5
+ value?: number;
6
+ };
@@ -0,0 +1,14 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { FormField } from "./formField";
4
+ export type FormFieldMultipleChoice = FormFieldBase & {
5
+ type?: FormFieldType.MultipleChoice;
6
+ value?: MultipleChoice;
7
+ };
8
+ type MultipleChoice = {
9
+ choice_id?: number;
10
+ choice_ids?: number[];
11
+ choice_names?: string[];
12
+ fields?: FormField[];
13
+ };
14
+ export {};
@@ -0,0 +1,5 @@
1
+ import { FormFieldFile } from "./formFieldFile";
2
+ import { NewFile } from "../newFile";
3
+ export type FormFieldNewFile = FormFieldFile & {
4
+ value?: NewFile[];
5
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldNote = FormFieldBase & {
4
+ type?: FormFieldType.Note;
5
+ value?: string;
6
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldNumber = FormFieldBase & {
4
+ type?: FormFieldType.Number;
5
+ value?: number;
6
+ };
@@ -0,0 +1,7 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { Person } from "../person";
4
+ export type FormFieldPerson = FormFieldBase & {
5
+ type?: FormFieldType.Person;
6
+ value?: Person;
7
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldPhone = FormFieldBase & {
4
+ type?: FormFieldType.Phone;
5
+ value?: string;
6
+ };
@@ -0,0 +1,15 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldProject = FormFieldBase & {
4
+ type?: FormFieldType.Project;
5
+ value?: ProjectArray;
6
+ };
7
+ type ProjectArray = {
8
+ projects: Project[];
9
+ };
10
+ type Project = {
11
+ id: number;
12
+ name?: string;
13
+ parent?: Project;
14
+ };
15
+ export {};
@@ -0,0 +1,7 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { Status } from "../../enums/status";
4
+ export type FormFieldStatus = FormFieldBase & {
5
+ type?: FormFieldType.Status;
6
+ value?: Status;
7
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldStep = FormFieldBase & {
4
+ type?: FormFieldType.Step;
5
+ value?: number;
6
+ };
@@ -0,0 +1,14 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { FormField } from "./formField";
4
+ export type FormFieldTable = FormFieldBase & {
5
+ type?: FormFieldType.Table;
6
+ value?: TableRow[];
7
+ };
8
+ type TableRow = {
9
+ row_id: number;
10
+ cells?: FormField[];
11
+ delete?: boolean;
12
+ deleted?: boolean;
13
+ };
14
+ export {};
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldText = FormFieldBase & {
4
+ type?: FormFieldType.Text;
5
+ value?: string;
6
+ };
@@ -0,0 +1,6 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ export type FormFieldTime = FormFieldBase & {
4
+ type?: FormFieldType.Time;
5
+ value?: Date;
6
+ };
@@ -0,0 +1,13 @@
1
+ import { FormFieldBase } from "./formFieldBase";
2
+ import { FormFieldType } from "../../enums/formFieldType";
3
+ import { Checkmark } from "../../enums/checkmark";
4
+ import { FormField } from "./formField";
5
+ export type FormFieldTitle = FormFieldBase & {
6
+ type?: FormFieldType.Title;
7
+ value?: Title;
8
+ };
9
+ type Title = {
10
+ checkmark?: Checkmark;
11
+ fields?: FormField[];
12
+ };
13
+ export {};
@@ -0,0 +1,5 @@
1
+ export type FormLink = {
2
+ task_id?: number;
3
+ task_ids?: number[];
4
+ subject?: string;
5
+ };
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Data for autofilling form fields
3
+ */
4
+ export type FormMapping = {
5
+ /**
6
+ * Pyrus form field symbol code
7
+ */
8
+ code: string;
9
+ /**
10
+ * Pyrus field value
11
+ *
12
+ * @remarks
13
+ * 300 symbols max
14
+ */
15
+ value: string;
16
+ };
@@ -0,0 +1,7 @@
1
+ export type NewFile = {
2
+ guid?: string;
3
+ root_id?: number;
4
+ attachment_id?: number;
5
+ url?: string;
6
+ name?: string;
7
+ };
@@ -0,0 +1,9 @@
1
+ import { Person } from "./person";
2
+ import { Role } from "./role";
3
+ export type Organization = {
4
+ organization_id: number;
5
+ name: string;
6
+ persons: Person[];
7
+ roles: Role[];
8
+ department_catalog_id?: number;
9
+ };
@@ -0,0 +1,19 @@
1
+ import { PersonType } from "../enums/personType";
2
+ export type Person = {
3
+ id: number;
4
+ first_name: string;
5
+ last_name: string;
6
+ native_first_name?: string;
7
+ native_last_name?: string;
8
+ email: string;
9
+ status?: string;
10
+ type: PersonType;
11
+ department_id?: string;
12
+ department_name?: string;
13
+ banned: boolean;
14
+ fired?: boolean;
15
+ task_receiver?: number;
16
+ position: string;
17
+ skype: string;
18
+ phone: string;
19
+ };
@@ -0,0 +1,15 @@
1
+ import { ListType } from "../enums/listType";
2
+ export type PlainTaskList = {
3
+ id: number;
4
+ parent_id?: number;
5
+ name: string;
6
+ color?: string;
7
+ deleted: boolean;
8
+ list_type: ListType;
9
+ has_form?: boolean;
10
+ manager_ids: number[];
11
+ member_ids?: number[];
12
+ version: number;
13
+ external_version?: number;
14
+ external_id?: number;
15
+ };
@@ -0,0 +1,4 @@
1
+ export type PrintForm = {
2
+ print_form_id: number;
3
+ print_form_name?: string;
4
+ };
@@ -0,0 +1,10 @@
1
+ export type Role = {
2
+ id: number;
3
+ name: string;
4
+ external_id?: string;
5
+ avatar_id?: number;
6
+ external_avatar_id?: number;
7
+ banned: boolean;
8
+ fired?: boolean;
9
+ member_ids: number[];
10
+ };
@@ -0,0 +1,4 @@
1
+ export type SessionLifespan = {
2
+ disable: boolean;
3
+ life_span_hours?: number;
4
+ };
@@ -0,0 +1,9 @@
1
+ export type SessionRestriction = {
2
+ disable: boolean;
3
+ max_count?: number;
4
+ };
5
+ export type SessionRestrictionUpdate = {
6
+ drop: boolean;
7
+ disable?: boolean;
8
+ max_count?: number;
9
+ };
@@ -0,0 +1,5 @@
1
+ export type Settings = {
2
+ apiUrl?: string;
3
+ authUrl: string;
4
+ filesUrl?: string;
5
+ };
@@ -0,0 +1,8 @@
1
+ import { SendSmsError } from "../enums/sendSmsError";
2
+ import { SendSmsStatus } from "../enums/sendSmsStatus";
3
+ export type SmsInfo = {
4
+ error_code?: SendSmsError;
5
+ status: SendSmsStatus;
6
+ error_message?: string;
7
+ sent_comment_id: number;
8
+ };
@@ -0,0 +1,5 @@
1
+ export type Step = {
2
+ step: number;
3
+ elapsed_time: number;
4
+ name?: string;
5
+ };
@@ -0,0 +1,6 @@
1
+ import { Person } from "./person";
2
+ import { ApprovalChoice } from "../enums/approvalChoice";
3
+ export type Subscriber = {
4
+ person: Person;
5
+ approval_choice?: ApprovalChoice;
6
+ };
@@ -0,0 +1,26 @@
1
+ import { AttachedFile } from "./attachedFile";
2
+ import { FormField } from "./formFields/formField";
3
+ import { Approval } from "./approval";
4
+ import { Subscriber } from "./subscriber";
5
+ import { Person } from "./person";
6
+ import { TaskHeader } from "./taskHeader";
7
+ export type Task = TaskHeader & {
8
+ due_date?: Date;
9
+ due?: Date;
10
+ scheduled_date?: Date;
11
+ scheduled_datetime_utc?: Date;
12
+ cancel_schedule?: boolean;
13
+ duration?: number;
14
+ form_id?: number;
15
+ attachments?: AttachedFile[];
16
+ fields?: FormField[];
17
+ approvals?: Approval[][];
18
+ subscribers?: Subscriber[];
19
+ participants?: Person[];
20
+ list_ids?: number[];
21
+ linked_task_ids?: number[];
22
+ parent_task_id?: number;
23
+ last_note_id?: number;
24
+ subject?: string;
25
+ is_closed: boolean;
26
+ };
@@ -0,0 +1,50 @@
1
+ import { Person } from "./person";
2
+ import { AttachedFile } from "./attachedFile";
3
+ import { Role } from "./role";
4
+ import { ApprovalChoice } from "../enums/approvalChoice";
5
+ import { ActivityAction } from "../enums/activityAction";
6
+ import { SmsInfo } from "./smsInfo";
7
+ import { Approval } from "./approval";
8
+ import { Channel } from "./channel";
9
+ import { FormField } from "./formFields/formField";
10
+ export type TaskComment = {
11
+ id: number;
12
+ text: string;
13
+ formatted_text?: string;
14
+ mentions?: number[];
15
+ subject?: string;
16
+ create_date: Date;
17
+ author: Person;
18
+ reassigned_to?: Person;
19
+ field_updates?: FormField[];
20
+ approval_choice?: ApprovalChoice;
21
+ reset_to_step?: number;
22
+ reply_note_id?: number;
23
+ approvals_added?: Approval[][];
24
+ approvals_removed?: Approval[][];
25
+ approvals_rerequested?: Approval[][];
26
+ subscribers_added?: Person[];
27
+ subscribers_removed?: Person[];
28
+ participants_added?: Person[];
29
+ participants_removed?: Person[];
30
+ due_date?: Date;
31
+ due?: Date;
32
+ scheduled_date?: Date;
33
+ scheduled_datetime_utc?: Date;
34
+ cancel_schedule?: boolean;
35
+ duration?: number;
36
+ attachments?: AttachedFile[];
37
+ action?: ActivityAction;
38
+ added_list_ids?: number[];
39
+ removed_list_ids?: number[];
40
+ approval_step?: number;
41
+ comment_as_roles?: Role[];
42
+ changed_step?: number;
43
+ channel?: Channel;
44
+ edit_comment_id?: number;
45
+ removed_attachment_ids?: number[];
46
+ delete_comment_id?: number;
47
+ spent_minutes?: number;
48
+ skip_satisfaction?: boolean;
49
+ sms_info?: SmsInfo;
50
+ };
@@ -0,0 +1,11 @@
1
+ import { Person } from "./person";
2
+ export type TaskHeader = {
3
+ id: number;
4
+ text: string;
5
+ create_date: Date;
6
+ last_modified_date: Date;
7
+ author: Person;
8
+ close_date?: Date;
9
+ responsible?: Person;
10
+ due_date?: Date;
11
+ };
@@ -0,0 +1,4 @@
1
+ import { PlainTaskList } from "./plainTaskList";
2
+ export type TaskList = PlainTaskList & {
3
+ children?: TaskList[];
4
+ };
@@ -0,0 +1,4 @@
1
+ export declare enum ActivityAction {
2
+ Finished = "finished",
3
+ Reopened = "reopened"
4
+ }
@@ -0,0 +1,7 @@
1
+ export declare enum ApprovalChoice {
2
+ Waiting = "waiting",
3
+ Approved = "approved",
4
+ Rejected = "rejected",
5
+ Revoked = "revoked",
6
+ Acknowledged = "acknowledged"
7
+ }
@@ -0,0 +1,3 @@
1
+ export declare enum CallEventType {
2
+ Show = "show"
3
+ }
@@ -0,0 +1,7 @@
1
+ export declare enum CallStatus {
2
+ Answered = "answered",
3
+ NoAnswer = "no answer",
4
+ Busy = "busy",
5
+ Error = "error",
6
+ Other = "other"
7
+ }
@@ -0,0 +1,23 @@
1
+ export declare enum ChannelType {
2
+ Email = "email",
3
+ Telegram = "telegram",
4
+ Web = "web",
5
+ Facebook = "facebook",
6
+ Vk = "vk",
7
+ Viber = "viber",
8
+ MobileApp = "mobile_app",
9
+ WebWidget = "web_widget",
10
+ MoySklad = "moy_sklad",
11
+ Zadarma = "zadarma",
12
+ AmoCrm = "amo_crm",
13
+ Instagram = "instagram",
14
+ PrivateChannel = "private_channel",
15
+ Jira = "jira",
16
+ Beeline = "beeline",
17
+ ApiTelephony = "api_telephony",
18
+ Zoom = "zoom",
19
+ WebForm = "web_form",
20
+ WhatsApp = "whats_app",
21
+ Custom = "custom",
22
+ Sms = "sms"
23
+ }
@@ -0,0 +1,4 @@
1
+ export declare enum Checkmark {
2
+ Checked = "checked",
3
+ Unchecked = "unchecked"
4
+ }
@@ -0,0 +1,6 @@
1
+ export declare enum DisconnectParty {
2
+ Agent = "agent",
3
+ Client = "client",
4
+ Error = "error",
5
+ Other = "other"
6
+ }
@@ -0,0 +1,123 @@
1
+ export declare enum ErrorCodeType {
2
+ ServerError = "server_error",
3
+ AuthorizationError = "authorization_error",
4
+ TokenNotSpecified = "token_not_specified",
5
+ RevokedToken = "revoked_token",
6
+ ExpiredToken = "expired_token",
7
+ InvalidToken = "invalid_token",
8
+ AccountBlocked = "account_blocked",
9
+ InvalidCredentials = "invalid_credentials",
10
+ InvalidApplicationId = "invalid_application_id",
11
+ InvalidFieldId = "invalid_field_id",
12
+ InvalidFieldName = "invalid_field_name",
13
+ InvalidFieldIdName = "invalid_field_id_name",
14
+ NonUniqueName = "non_unique_name",
15
+ FieldIdentityMissing = "field_identity_missing",
16
+ DuplicateField = "duplicate_field",
17
+ InvalidCatalogId = "invalid_catalog_id",
18
+ InvalidCatalogItemName = "invalid_catalog_item_name",
19
+ NonUniqueCatalogItemName = "non_unique_catalog_item_name",
20
+ InvalidCatalogItemId = "invalid_catalog_item_id",
21
+ InvalidCatalogItemIdName = "catalog_item_id_name_mismatch",
22
+ InvalidEmail = "invalid_email",
23
+ NonUniqueEmail = "non_unique_email",
24
+ InvalidPersonIdEmail = "invalid_person_id_email",
25
+ UnrecognizedAttachmentId = "unrecognized_attachment_id",
26
+ RequiredFieldMissing = "required_field_missing",
27
+ FieldTypeIsNotSupported = "type_is_not_supported",
28
+ IncorrectParametersCount = "incorrect_parameters_count",
29
+ FilterTypeIsNotSupported = "filter_type_is_not_supported",
30
+ StepFieldDoesNotExists = "step_field_does_not_exists",
31
+ NoFileInRequest = "no_file_in_request",
32
+ TooLargeRequestLength = "too_large_request_length",
33
+ TaskHasNoForm = "task_has_no_form",
34
+ RequiredParameterMissing = "required_parameter_missing",
35
+ InvalidValueFormat = "invalid_value_format",
36
+ InvalidJson = "invalid_json",
37
+ EmptyBody = "empty_body",
38
+ TextMissing = "text_missing",
39
+ FormIdMissing = "form_id_missing",
40
+ InvalidPersonId = "invalid_person_id",
41
+ DeletedField = "deleted_field",
42
+ PersonIdentityMissing = "person_identity_missing",
43
+ CatalogItemIdMissing = "catalog_identity_missing",
44
+ FormHasNoTask = "form_has_no_task",
45
+ EitherDueDateOrDueCanBeSet = "either_due_date_or_due_can_be_set",
46
+ NegativeDuration = "negative_duration",
47
+ DurationIsTooLong = "duration_is_too_long",
48
+ DueMissing = "due_missing",
49
+ ScheduledDateInPast = "scheduled_date_in_past",
50
+ CannotAddFormProject = "cannot_add_form_project",
51
+ FormTemplateCantBeRemovedFromTask = "form_template_cant_be_removed_from_task",
52
+ TooManyTaskSteps = "too_many_task_steps",
53
+ TooManyComments = "too_many_comments",
54
+ InvalidStepNumber = "invalid_step_number",
55
+ TaskLimitExceeded = "task_limit_exceeded",
56
+ FieldIsInTable = "field_is_in_table",
57
+ RequiredTableFieldMissing = "required_table_field_missing",
58
+ DepartmentCatalogCanNotBeModified = "department_catalog_can_not_be_modified",
59
+ CatalogDuplicateItems = "catalog_duplicate_rows",
60
+ EmptyCatalogHeaders = "empty_catalog_headers",
61
+ CanNotModifyDeletedCatalog = "can_not_modify_deleted_catalog",
62
+ CatalogDuplicateHeaders = "catalog_duplicate_headers",
63
+ CanNotModifyFirstColumn = "can_not_modify_first_column",
64
+ CatalogHeadersItemsMismatch = "catalog_headers_items_mismatch",
65
+ TooManyCatalogItems = "too_many_catalog_items",
66
+ CatalogItemMaxLengthExceeded = "catalog_item_max_length_exceeded",
67
+ SingleValueIsNotSupported = "single_value_is_not_supported",
68
+ ParticipantLimitExceeded = "participant_limit_exceeded",
69
+ TableRowsLimitExceeded = "table_rows_limit_exceeded",
70
+ TextFieldValueLimitExceeded = "text_field_value_limit_exceeded",
71
+ UnableToEditField = "unable_to_edit_field",
72
+ EmptyFile = "empty_file",
73
+ BadMultipartContent = "bad_multipart_content",
74
+ TooManyDecimalPlaces = "too_many_decimal_places",
75
+ ExternalCommentEmptyText = "external_comment_empty_text",
76
+ SenderAddressFieldMissing = "sender_address_field_missing",
77
+ ExternalCommentRecipientNotFound = "external_comment_recipient_not_found",
78
+ DefaultMailboxNotFound = "default_mailbox_not_found",
79
+ CatalogNullValue = "catalog_null_value",
80
+ MaxTextLengthExceeded = "max_text_length_exceeded",
81
+ DueOutsideOfBounds = "due_outside_of_bounds",
82
+ AttachmentsForbidden = "attachments_forbidden",
83
+ UnrecognizedCallGuid = "unrecognized_call_guid",
84
+ UnsupportedAttachmentFormat = "unsupported_attachment_format",
85
+ ValidationError = "validation_error",
86
+ UnrecognizedAccountId = "unrecognized_account_id",
87
+ WebhookIsDisabled = "webhook_is_disabled",
88
+ TooLargeMessageText = "too_large_message_text",
89
+ UnrecognizedMessageType = "unrecognized_message_type",
90
+ InvalidFieldMappingCode = "invalid_field_mapping_code",
91
+ TooManyAttachments = "too_many_attachments",
92
+ UnrecognizedCallId = "unrecognized_call_id",
93
+ UnsupportedRecordFileFormat = "unsupported_record_file_format",
94
+ UnrecognizedIntegrationGuid = "unrecognized_integration_guid",
95
+ LimitExceeded = "limit_exceeded",
96
+ MaxSmsTextLengthExceeded = "max_sms_text_length_exceeded",
97
+ SmsIntegrationNotConfigured = "sms_integration_not_configured",
98
+ AttachmentTooBig = "attachment_too_big",
99
+ UncreatedOrDeletedTableRows = "invalid_table_row",
100
+ PrivateChannelAccessDenied = "private_channel_access_denied",
101
+ PrivateCommentHasForbiddenChanges = "private_comment_has_forbidden_changes",
102
+ ItemsCountOutOfRange = "items_count_out_of_range",
103
+ CannotAddExternalUser = "cannot_add_external_user",
104
+ UnrecognizedTaskId = "unrecognized_task_id",
105
+ TooManyDeletedCatalogItems = "too_many_deleted_catalog_items",
106
+ FieldCannotHaveMultipleValues = "field_cannot_have_multiple_values",
107
+ FieldEditingIsNotAllowed = "field_editing_is_not_allowed",
108
+ NonUniqueCode = "non_unique_code",
109
+ InvalidFieldCode = "invalid_field_code",
110
+ AccessDeniedProject = "access_denied_project",
111
+ AccessDeniedTask = "access_denied_task",
112
+ AccessDeniedCatalog = "access_denied_catalog",
113
+ AccessDeniedForm = "access_denied_form",
114
+ AccessDeniedPerson = "access_denied_person",
115
+ AccessDeniedCloseTask = "access_denied_close_task",
116
+ AccessDeniedReopenTask = "access_denied_reopen_task",
117
+ AccessDeniedFileAccessHistory = "access_denied_file_access_history",
118
+ AccessDeniedFile = "access_denied_file",
119
+ AccessDeniedReport = "access_denied_report",
120
+ AccessDenied = "access_denied",
121
+ FileIsMissing = "file_is_missing",
122
+ TooManyRequests = "too_many_requests"
123
+ }
@@ -0,0 +1,20 @@
1
+ export declare enum FilterMask {
2
+ /**
3
+ * Events whose deadline is indicated in UTC+0
4
+ */
5
+ Due = 1,
6
+ /**
7
+ * Tasks whose deadline is indicated by date
8
+ * (without reference to timezone)
9
+ */
10
+ DueDate = 2,
11
+ /**
12
+ * Tasks whose deadline at the current step is
13
+ * within the selected time period in UTC+0
14
+ */
15
+ DueForCurrentStep = 4,
16
+ /**
17
+ * Tasks with a programmed reminder
18
+ */
19
+ Reminded = 8
20
+ }