pyrus-api 1.0.2 → 2.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 (173) hide show
  1. package/build/cjs/index.cjs +240 -234
  2. package/build/esm/index.js +223 -231
  3. package/build/types/index.d.ts +1426 -51
  4. package/package.json +3 -2
  5. package/build/types/src/api/announcementsApi.d.ts +0 -14
  6. package/build/types/src/api/baseApi.d.ts +0 -21
  7. package/build/types/src/api/botApi.d.ts +0 -17
  8. package/build/types/src/api/calendarApi.d.ts +0 -8
  9. package/build/types/src/api/callApi.d.ts +0 -11
  10. package/build/types/src/api/catalogsApi.d.ts +0 -22
  11. package/build/types/src/api/contactsApi.d.ts +0 -8
  12. package/build/types/src/api/filesApi.d.ts +0 -8
  13. package/build/types/src/api/formsApi.d.ts +0 -17
  14. package/build/types/src/api/index.d.ts +0 -1
  15. package/build/types/src/api/listsApi.d.ts +0 -20
  16. package/build/types/src/api/logsApi.d.ts +0 -13
  17. package/build/types/src/api/membersApi.d.ts +0 -21
  18. package/build/types/src/api/profileApi.d.ts +0 -8
  19. package/build/types/src/api/pyrusApiClient.d.ts +0 -57
  20. package/build/types/src/api/roleApi.d.ts +0 -15
  21. package/build/types/src/api/tasksApi.d.ts +0 -18
  22. package/build/types/src/entities/TaskWithComments.d.ts +0 -7
  23. package/build/types/src/entities/announcementComment.d.ts +0 -12
  24. package/build/types/src/entities/announcementWithComments.d.ts +0 -13
  25. package/build/types/src/entities/approval.d.ts +0 -7
  26. package/build/types/src/entities/attachedFile.d.ts +0 -9
  27. package/build/types/src/entities/bot.d.ts +0 -15
  28. package/build/types/src/entities/catalogHeader.d.ts +0 -9
  29. package/build/types/src/entities/catalogInfo.d.ts +0 -19
  30. package/build/types/src/entities/catalogItem.d.ts +0 -12
  31. package/build/types/src/entities/channel.d.ts +0 -8
  32. package/build/types/src/entities/channelUser.d.ts +0 -4
  33. package/build/types/src/entities/columnSettings.d.ts +0 -6
  34. package/build/types/src/entities/commentDescription.d.ts +0 -6
  35. package/build/types/src/entities/department.d.ts +0 -7
  36. package/build/types/src/entities/dueFilter.d.ts +0 -3
  37. package/build/types/src/entities/formFieldInfo.d.ts +0 -21
  38. package/build/types/src/entities/formFields/formField.d.ts +0 -26
  39. package/build/types/src/entities/formFields/formFieldAuthor.d.ts +0 -7
  40. package/build/types/src/entities/formFields/formFieldBase.d.ts +0 -12
  41. package/build/types/src/entities/formFields/formFieldCatalog.d.ts +0 -15
  42. package/build/types/src/entities/formFields/formFieldCheckmark.d.ts +0 -7
  43. package/build/types/src/entities/formFields/formFieldCreateDate.d.ts +0 -6
  44. package/build/types/src/entities/formFields/formFieldDate.d.ts +0 -6
  45. package/build/types/src/entities/formFields/formFieldDueDate.d.ts +0 -6
  46. package/build/types/src/entities/formFields/formFieldDueDateTime.d.ts +0 -6
  47. package/build/types/src/entities/formFields/formFieldEmail.d.ts +0 -6
  48. package/build/types/src/entities/formFields/formFieldFile.d.ts +0 -7
  49. package/build/types/src/entities/formFields/formFieldFlag.d.ts +0 -7
  50. package/build/types/src/entities/formFields/formFieldFormLink.d.ts +0 -7
  51. package/build/types/src/entities/formFields/formFieldMoney.d.ts +0 -6
  52. package/build/types/src/entities/formFields/formFieldMultipleChoice.d.ts +0 -14
  53. package/build/types/src/entities/formFields/formFieldNewFile.d.ts +0 -5
  54. package/build/types/src/entities/formFields/formFieldNote.d.ts +0 -6
  55. package/build/types/src/entities/formFields/formFieldNumber.d.ts +0 -6
  56. package/build/types/src/entities/formFields/formFieldPerson.d.ts +0 -7
  57. package/build/types/src/entities/formFields/formFieldPhone.d.ts +0 -6
  58. package/build/types/src/entities/formFields/formFieldProject.d.ts +0 -15
  59. package/build/types/src/entities/formFields/formFieldStatus.d.ts +0 -7
  60. package/build/types/src/entities/formFields/formFieldStep.d.ts +0 -6
  61. package/build/types/src/entities/formFields/formFieldTable.d.ts +0 -14
  62. package/build/types/src/entities/formFields/formFieldText.d.ts +0 -6
  63. package/build/types/src/entities/formFields/formFieldTime.d.ts +0 -6
  64. package/build/types/src/entities/formFields/formFieldTitle.d.ts +0 -13
  65. package/build/types/src/entities/formLink.d.ts +0 -5
  66. package/build/types/src/entities/formMapping.d.ts +0 -16
  67. package/build/types/src/entities/newFile.d.ts +0 -7
  68. package/build/types/src/entities/organization.d.ts +0 -9
  69. package/build/types/src/entities/person.d.ts +0 -19
  70. package/build/types/src/entities/plainTaskList.d.ts +0 -15
  71. package/build/types/src/entities/printForm.d.ts +0 -4
  72. package/build/types/src/entities/role.d.ts +0 -10
  73. package/build/types/src/entities/sessionLifespan.d.ts +0 -4
  74. package/build/types/src/entities/sessionRestriction.d.ts +0 -9
  75. package/build/types/src/entities/settings.d.ts +0 -5
  76. package/build/types/src/entities/smsInfo.d.ts +0 -8
  77. package/build/types/src/entities/step.d.ts +0 -5
  78. package/build/types/src/entities/subscriber.d.ts +0 -6
  79. package/build/types/src/entities/task.d.ts +0 -26
  80. package/build/types/src/entities/taskComment.d.ts +0 -50
  81. package/build/types/src/entities/taskHeader.d.ts +0 -11
  82. package/build/types/src/entities/taskList.d.ts +0 -4
  83. package/build/types/src/enums/activityAction.d.ts +0 -4
  84. package/build/types/src/enums/approvalChoice.d.ts +0 -7
  85. package/build/types/src/enums/callEventType.d.ts +0 -3
  86. package/build/types/src/enums/callStatus.d.ts +0 -7
  87. package/build/types/src/enums/channelType.d.ts +0 -23
  88. package/build/types/src/enums/checkmark.d.ts +0 -4
  89. package/build/types/src/enums/disconnectParty.d.ts +0 -6
  90. package/build/types/src/enums/errorCodeType.d.ts +0 -123
  91. package/build/types/src/enums/filterMask.d.ts +0 -20
  92. package/build/types/src/enums/flag.d.ts +0 -5
  93. package/build/types/src/enums/formFieldType.d.ts +0 -27
  94. package/build/types/src/enums/listType.d.ts +0 -4
  95. package/build/types/src/enums/operatorId.d.ts +0 -9
  96. package/build/types/src/enums/permissionLevel.d.ts +0 -6
  97. package/build/types/src/enums/personRights.d.ts +0 -24
  98. package/build/types/src/enums/personType.d.ts +0 -5
  99. package/build/types/src/enums/sendSmsError.d.ts +0 -11
  100. package/build/types/src/enums/sendSmsStatus.d.ts +0 -6
  101. package/build/types/src/enums/sourceType.d.ts +0 -4
  102. package/build/types/src/enums/status.d.ts +0 -4
  103. package/build/types/src/helpers/constants.d.ts +0 -8
  104. package/build/types/src/helpers/functions.d.ts +0 -13
  105. package/build/types/src/helpers/types.d.ts +0 -4
  106. package/build/types/src/requests/announcementCommentRequest.d.ts +0 -6
  107. package/build/types/src/requests/announcementRequest.d.ts +0 -6
  108. package/build/types/src/requests/attachCallRecordRequest.d.ts +0 -37
  109. package/build/types/src/requests/authRequest.d.ts +0 -11
  110. package/build/types/src/requests/calendarTasksRequest.d.ts +0 -24
  111. package/build/types/src/requests/callRequest.d.ts +0 -27
  112. package/build/types/src/requests/catalogRequestBase.d.ts +0 -15
  113. package/build/types/src/requests/changePermissionsRequest.d.ts +0 -4
  114. package/build/types/src/requests/contactsRequest.d.ts +0 -3
  115. package/build/types/src/requests/createBotRequest.d.ts +0 -5
  116. package/build/types/src/requests/createCallRequest.d.ts +0 -6
  117. package/build/types/src/requests/createCatalogRequest.d.ts +0 -6
  118. package/build/types/src/requests/createDepartmentRequest.d.ts +0 -6
  119. package/build/types/src/requests/createListRequest.d.ts +0 -12
  120. package/build/types/src/requests/createMemberRequest.d.ts +0 -12
  121. package/build/types/src/requests/createRoleRequest.d.ts +0 -5
  122. package/build/types/src/requests/deleteBotRequest.d.ts +0 -4
  123. package/build/types/src/requests/deleteRoleRequest.d.ts +0 -4
  124. package/build/types/src/requests/formFilter.d.ts +0 -6
  125. package/build/types/src/requests/formRegisterRequest.d.ts +0 -26
  126. package/build/types/src/requests/getAllRequest.d.ts +0 -3
  127. package/build/types/src/requests/getMessageRequest.d.ts +0 -10
  128. package/build/types/src/requests/inboxRequest.d.ts +0 -8
  129. package/build/types/src/requests/personIdentity.d.ts +0 -4
  130. package/build/types/src/requests/profileRequest.d.ts +0 -3
  131. package/build/types/src/requests/setAvatarRequest.d.ts +0 -4
  132. package/build/types/src/requests/syncCatalogRequest.d.ts +0 -6
  133. package/build/types/src/requests/taskCommentRequest.d.ts +0 -39
  134. package/build/types/src/requests/taskListRequest.d.ts +0 -10
  135. package/build/types/src/requests/taskRequest.d.ts +0 -24
  136. package/build/types/src/requests/updateBotRequest.d.ts +0 -13
  137. package/build/types/src/requests/updateDepartmentRequest.d.ts +0 -8
  138. package/build/types/src/requests/updateListRequest.d.ts +0 -14
  139. package/build/types/src/requests/updateMemberRequest.d.ts +0 -15
  140. package/build/types/src/requests/updateRoleRequest.d.ts +0 -8
  141. package/build/types/src/responses/announcementResponse.d.ts +0 -5
  142. package/build/types/src/responses/announcementsResponse.d.ts +0 -5
  143. package/build/types/src/responses/authResponse.d.ts +0 -6
  144. package/build/types/src/responses/botResponse.d.ts +0 -3
  145. package/build/types/src/responses/botsResponse.d.ts +0 -5
  146. package/build/types/src/responses/calendarResponse.d.ts +0 -6
  147. package/build/types/src/responses/callResponse.d.ts +0 -4
  148. package/build/types/src/responses/catalogItemResponse.d.ts +0 -4
  149. package/build/types/src/responses/catalogResponse.d.ts +0 -18
  150. package/build/types/src/responses/contactsResponse.d.ts +0 -5
  151. package/build/types/src/responses/departmentResponse.d.ts +0 -3
  152. package/build/types/src/responses/departmentsResponse.d.ts +0 -5
  153. package/build/types/src/responses/formRegisterResponse.d.ts +0 -5
  154. package/build/types/src/responses/formResponse.d.ts +0 -17
  155. package/build/types/src/responses/formsResponse.d.ts +0 -4
  156. package/build/types/src/responses/listsResponse.d.ts +0 -5
  157. package/build/types/src/responses/memberResponse.d.ts +0 -3
  158. package/build/types/src/responses/membersResponse.d.ts +0 -5
  159. package/build/types/src/responses/permissionsDict.d.ts +0 -4
  160. package/build/types/src/responses/permissionsResponse.d.ts +0 -5
  161. package/build/types/src/responses/plainListResponse.d.ts +0 -3
  162. package/build/types/src/responses/profileIdentityResponse.d.ts +0 -5
  163. package/build/types/src/responses/profileResponse.d.ts +0 -12
  164. package/build/types/src/responses/responseBase.d.ts +0 -6
  165. package/build/types/src/responses/roleResponse.d.ts +0 -3
  166. package/build/types/src/responses/rolesResponse.d.ts +0 -5
  167. package/build/types/src/responses/syncCatalogResponse.d.ts +0 -10
  168. package/build/types/src/responses/taskListResponse.d.ts +0 -6
  169. package/build/types/src/responses/taskResponse.d.ts +0 -5
  170. package/build/types/src/responses/uploadResponse.d.ts +0 -5
  171. package/build/types/src/responses//321/201atalogsResponse.d.ts +0 -5
  172. package/build/types/src/settings/defaults.d.ts +0 -2
  173. package/build/types/src/settings/endpoints.d.ts +0 -32
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pyrus-api",
3
- "version": "1.0.2",
3
+ "version": "2.0.0",
4
4
  "description": "Pyrus API client for TypeScript",
5
5
  "repository": {
6
6
  "type": "git",
@@ -22,7 +22,7 @@
22
22
  }
23
23
  },
24
24
  "scripts": {
25
- "build": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript && tsc --declaration --emitDeclarationOnly ",
25
+ "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",
26
26
  "prepare": "husky"
27
27
  },
28
28
  "author": {
@@ -34,6 +34,7 @@
34
34
  "@rollup/plugin-typescript": "^11.1.6",
35
35
  "@types/node": "^22.5.4",
36
36
  "@types/rollup": "^0.54.0",
37
+ "dts-bundle-generator": "^9.5.1",
37
38
  "husky": "^9.1.6",
38
39
  "lint-staged": "^15.2.10",
39
40
  "prettier": "2.5.1",
@@ -1,14 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { AnnouncementsResponse } from "../responses/announcementsResponse";
4
- import { ById } from "../helpers/types";
5
- import { AnnouncementResponse } from "../responses/announcementResponse";
6
- import { AnnouncementRequest } from "../requests/announcementRequest";
7
- import { AnnouncementCommentRequest } from "../requests/announcementCommentRequest";
8
- export declare class AnnouncementsApi extends BaseApi {
9
- protected _moduleSubPath: Endpoints;
10
- getAll(): Promise<AnnouncementsResponse>;
11
- get({ id }: ById): Promise<AnnouncementResponse>;
12
- create(request: AnnouncementRequest): Promise<AnnouncementResponse>;
13
- addComment(id: number, request: AnnouncementCommentRequest): Promise<AnnouncementResponse>;
14
- }
@@ -1,21 +0,0 @@
1
- import { Settings } from "../entities/settings";
2
- import { AuthResponse } from "../responses/authResponse";
3
- import { HTTPMethod } from "../helpers/types";
4
- export interface BaseApiParams {
5
- token?: string;
6
- settings?: Settings;
7
- authRequest?: Promise<AuthResponse>;
8
- }
9
- export declare abstract class BaseApi {
10
- protected _token: string;
11
- protected _settings: Settings;
12
- protected _authRequest: Promise<AuthResponse>;
13
- protected _moduleSubPath: string;
14
- protected constructor({ token, authRequest, settings }: BaseApiParams);
15
- protected loginDone(): Promise<void>;
16
- protected fetchApi<T>(url: string, method: HTTPMethod, body?: BodyInit, headersOverride?: HeadersInit): Promise<T>;
17
- protected _checkResponse(resp: Response): Promise<any>;
18
- protected getModulePath(): Promise<string>;
19
- protected authorisationHeader(): Promise<Record<string, string>>;
20
- private defaultHeaders;
21
- }
@@ -1,17 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ById } from "../helpers/types";
4
- import { CreateBotRequest } from "../requests/createBotRequest";
5
- import { BotResponse } from "../responses/botResponse";
6
- import { BotsResponse } from "../responses/botsResponse";
7
- import { UpdateBotRequest } from "../requests/updateBotRequest";
8
- import { DeleteBotRequest } from "../requests/deleteBotRequest";
9
- import { GetAllRequest } from "../requests/getAllRequest";
10
- export declare class BotApi extends BaseApi {
11
- protected _moduleSubPath: Endpoints;
12
- create(request: CreateBotRequest): Promise<BotResponse>;
13
- get({ id }: ById): Promise<BotResponse>;
14
- getAll(request?: GetAllRequest): Promise<BotsResponse>;
15
- update(request: UpdateBotRequest): Promise<BotResponse>;
16
- delete(request: DeleteBotRequest): Promise<BotResponse>;
17
- }
@@ -1,8 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { CalendarTasksRequest } from "../requests/calendarTasksRequest";
4
- import { CalendarResponse } from "../responses/calendarResponse";
5
- export declare class CalendarApi extends BaseApi {
6
- protected _moduleSubPath: Endpoints;
7
- getTasks(request: CalendarTasksRequest): Promise<CalendarResponse>;
8
- }
@@ -1,11 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { CallRequest } from "../requests/callRequest";
4
- import { CallResponse } from "../responses/callResponse";
5
- import { AttachCallRecordRequest } from "../requests/attachCallRecordRequest";
6
- import { ResponseBase } from "../responses/responseBase";
7
- export declare class CallApi extends BaseApi {
8
- protected _moduleSubPath: Endpoints;
9
- registerCall(request: CallRequest): Promise<CallResponse>;
10
- attachCallRecord(request: AttachCallRecordRequest): Promise<ResponseBase>;
11
- }
@@ -1,22 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ById } from "../helpers/types";
4
- import { CatalogsResponse } from "../responses/сatalogsResponse";
5
- import { CatalogResponse } from "../responses/catalogResponse";
6
- import { CreateCatalogRequest } from "../requests/createCatalogRequest";
7
- import { SyncCatalogRequest } from "../requests/syncCatalogRequest";
8
- import { SyncCatalogResponse } from "../responses/syncCatalogResponse";
9
- export declare class CatalogsApi extends BaseApi {
10
- protected _moduleSubPath: Endpoints;
11
- getAll(): Promise<CatalogsResponse>;
12
- get({ id }: ById): Promise<CatalogResponse>;
13
- create(request: CreateCatalogRequest): Promise<CatalogResponse>;
14
- /**
15
- * This method updates catalog headers and items.
16
- * You must define all the values and text columns that need to remain in the catalog.
17
- *
18
- * All unspecified items and text columns will be deleted
19
- * @param request
20
- */
21
- sync(request: SyncCatalogRequest): Promise<SyncCatalogResponse>;
22
- }
@@ -1,8 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ContactsRequest } from "../requests/contactsRequest";
4
- import { ContactsResponse } from "../responses/contactsResponse";
5
- export declare class ContactsApi extends BaseApi {
6
- protected _moduleSubPath: Endpoints;
7
- getAll(request?: ContactsRequest): Promise<ContactsResponse>;
8
- }
@@ -1,8 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { UploadResponse } from "../responses/uploadResponse";
3
- import { ById } from "../helpers/types";
4
- export declare class FilesApi extends BaseApi {
5
- upload(file: Blob, filename: string): Promise<UploadResponse>;
6
- download({ id }: ById): Promise<Blob>;
7
- private _filePath;
8
- }
@@ -1,17 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ById } from "../helpers/types";
4
- import { FormResponse } from "../responses/formResponse";
5
- import { FormsResponse } from "../responses/formsResponse";
6
- import { FormRegisterRequest } from "../requests/formRegisterRequest";
7
- import { FormRegisterResponse } from "../responses/formRegisterResponse";
8
- import { PermissionsResponse } from "../responses/permissionsResponse";
9
- import { ChangePermissionsRequest } from "../requests/changePermissionsRequest";
10
- export declare class FormsApi extends BaseApi {
11
- protected _moduleSubPath: Endpoints;
12
- get({ id }: ById): Promise<FormResponse>;
13
- getAll(): Promise<FormsResponse>;
14
- getTasks(id: number, request: FormRegisterRequest): Promise<FormRegisterResponse>;
15
- getPermissions({ id }: ById): Promise<PermissionsResponse>;
16
- setPermissions(id: number, request: ChangePermissionsRequest): Promise<PermissionsResponse>;
17
- }
@@ -1 +0,0 @@
1
- export { PyrusApiClient } from "./pyrusApiClient";
@@ -1,20 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ListsResponse } from "../responses/listsResponse";
4
- import { TaskListRequest } from "../requests/taskListRequest";
5
- import { TaskListResponse } from "../responses/taskListResponse";
6
- import { InboxRequest } from "../requests/inboxRequest";
7
- import { ById } from "../helpers/types";
8
- import { ResponseBase } from "../responses/responseBase";
9
- import { CreateListRequest } from "../requests/createListRequest";
10
- import { PlainListResponse } from "../responses/plainListResponse";
11
- import { UpdateListRequest } from "../requests/updateListRequest";
12
- export declare class ListsApi extends BaseApi {
13
- protected _moduleSubPath: Endpoints;
14
- getAll(): Promise<ListsResponse>;
15
- getTasksInList(listId: number, request?: TaskListRequest): Promise<TaskListResponse>;
16
- getInbox(request?: InboxRequest): Promise<TaskListResponse>;
17
- create(request: CreateListRequest): Promise<PlainListResponse>;
18
- delete(request: ById): Promise<ResponseBase>;
19
- update(request: UpdateListRequest): Promise<PlainListResponse>;
20
- }
@@ -1,13 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- type LogsParameters = {
3
- after?: number;
4
- count?: number;
5
- };
6
- export declare class LogsApi extends BaseApi {
7
- getEvents(request?: LogsParameters): Promise<Blob>;
8
- getFileAccess(request?: LogsParameters): Promise<Blob>;
9
- getTaskAccess(request?: LogsParameters): Promise<Blob>;
10
- getTaskExport(request?: LogsParameters): Promise<Blob>;
11
- getRegistryDownload(request?: LogsParameters): Promise<Blob>;
12
- }
13
- export {};
@@ -1,21 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ById } from "../helpers/types";
4
- import { MembersResponse } from "../responses/membersResponse";
5
- import { MemberResponse } from "../responses/memberResponse";
6
- import { CreateMemberRequest } from "../requests/createMemberRequest";
7
- import { UpdateMemberRequest } from "../requests/updateMemberRequest";
8
- import { GetAllRequest } from "../requests/getAllRequest";
9
- export declare class MembersApi extends BaseApi {
10
- protected _moduleSubPath: Endpoints;
11
- /**
12
- *
13
- * @param request
14
- * "email" and one of "first_name" or "last_name" are required
15
- */
16
- create(request: CreateMemberRequest): Promise<MemberResponse>;
17
- get({ id }: ById): Promise<MemberResponse>;
18
- getAll(request?: GetAllRequest): Promise<MembersResponse>;
19
- update(request: UpdateMemberRequest): Promise<MemberResponse>;
20
- delete({ id }: ById): Promise<MemberResponse>;
21
- }
@@ -1,8 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ProfileResponse } from "../responses/profileResponse";
4
- import { ProfileRequest } from "../requests/profileRequest";
5
- export declare class ProfileApi extends BaseApi {
6
- protected _moduleSubPath: Endpoints;
7
- get(request?: ProfileRequest): Promise<ProfileResponse>;
8
- }
@@ -1,57 +0,0 @@
1
- import { AuthRequest } from "../requests/authRequest";
2
- import { BaseApi } from "./baseApi";
3
- import { Settings } from "../entities/settings";
4
- import { RoleApi } from "./roleApi";
5
- import { ProfileApi } from "./profileApi";
6
- import { ContactsApi } from "./contactsApi";
7
- import { FilesApi } from "./filesApi";
8
- import { ListsApi } from "./listsApi";
9
- import { CalendarApi } from "./calendarApi";
10
- import { AnnouncementsApi } from "./announcementsApi";
11
- import { CatalogsApi } from "./catalogsApi";
12
- import { MembersApi } from "./membersApi";
13
- import { TasksApi } from "./tasksApi";
14
- import { FormsApi } from "./formsApi";
15
- import { LogsApi } from "./logsApi";
16
- import { CallApi } from "./callApi";
17
- import { BotApi } from "./botApi";
18
- export declare class PyrusApiClient extends BaseApi {
19
- private _role;
20
- private _profile;
21
- private _contacts;
22
- private _files;
23
- private _lists;
24
- private _calendar;
25
- private _announcements;
26
- private _catalogs;
27
- private _members;
28
- private _tasks;
29
- private _forms;
30
- private _logs;
31
- private _call;
32
- private _bot;
33
- /**
34
- *
35
- * @param auth
36
- * can be AuthRequest type or token
37
- * @param settings
38
- * connection settings
39
- */
40
- constructor(auth: AuthRequest | string, settings?: Settings);
41
- private _authenticateClient;
42
- private get initParams();
43
- get role(): RoleApi;
44
- get profile(): ProfileApi;
45
- get contacts(): ContactsApi;
46
- get files(): FilesApi;
47
- get lists(): ListsApi;
48
- get calendar(): CalendarApi;
49
- get announcements(): AnnouncementsApi;
50
- get catalogs(): CatalogsApi;
51
- get members(): MembersApi;
52
- get tasks(): TasksApi;
53
- get forms(): FormsApi;
54
- get logs(): LogsApi;
55
- get call(): CallApi;
56
- get bot(): BotApi;
57
- }
@@ -1,15 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { CreateRoleRequest } from "../requests/createRoleRequest";
3
- import { Endpoints } from "../settings/endpoints";
4
- import { ById } from "../helpers/types";
5
- import { RoleResponse } from "../responses/roleResponse";
6
- import { RolesResponse } from "../responses/rolesResponse";
7
- import { UpdateRoleRequest } from "../requests/updateRoleRequest";
8
- import { GetAllRequest } from "../requests/getAllRequest";
9
- export declare class RoleApi extends BaseApi {
10
- protected _moduleSubPath: Endpoints;
11
- create(request: CreateRoleRequest): Promise<RoleResponse>;
12
- get({ id }: ById): Promise<RoleResponse>;
13
- getAll(request?: GetAllRequest): Promise<RolesResponse>;
14
- update(request: UpdateRoleRequest): Promise<RoleResponse>;
15
- }
@@ -1,18 +0,0 @@
1
- import { BaseApi } from "./baseApi";
2
- import { Endpoints } from "../settings/endpoints";
3
- import { ById } from "../helpers/types";
4
- import { TaskResponse } from "../responses/taskResponse";
5
- import { TaskRequest } from "../requests/taskRequest";
6
- import { TaskCommentRequest } from "../requests/taskCommentRequest";
7
- export declare class TasksApi extends BaseApi {
8
- protected _moduleSubPath: Endpoints;
9
- get({ id }: ById): Promise<TaskResponse>;
10
- /**
11
- *
12
- * @param request
13
- * If "form_id" specified it will be Form task,
14
- * else - Simple task.
15
- */
16
- create(request: TaskRequest): Promise<TaskResponse>;
17
- addComment(id: number, request: TaskCommentRequest): Promise<TaskResponse>;
18
- }
@@ -1,7 +0,0 @@
1
- import { Task } from "./task";
2
- import { TaskComment } from "./taskComment";
3
- import { Step } from "./step";
4
- export type TaskWithComments = Task & {
5
- comments: TaskComment[];
6
- steps?: Step[];
7
- };
@@ -1,12 +0,0 @@
1
- import { Person } from "./person";
2
- import { AttachedFile } from "./attachedFile";
3
- import { TaskComment } from "./taskComment";
4
- export type AnnouncementComment = {
5
- id: number;
6
- text?: string;
7
- formatted_text?: string;
8
- create_date: Date;
9
- author: Person;
10
- attachments?: AttachedFile[];
11
- comments?: TaskComment[];
12
- };
@@ -1,13 +0,0 @@
1
- import { Person } from "./person";
2
- import { AttachedFile } from "./attachedFile";
3
- import { AnnouncementComment } from "./announcementComment";
4
- export type AnnouncementWithComments = {
5
- id: number;
6
- text: string;
7
- formatted_text: string;
8
- create_date: Date;
9
- last_modified_date: Date;
10
- author: Person;
11
- attachments?: AttachedFile[];
12
- comments?: AnnouncementComment[];
13
- };
@@ -1,7 +0,0 @@
1
- import { Person } from "./person";
2
- import { ApprovalChoice } from "../enums/approvalChoice";
3
- export type Approval = {
4
- person: Person;
5
- approval_choice?: ApprovalChoice;
6
- step?: number;
7
- };
@@ -1,9 +0,0 @@
1
- export type AttachedFile = {
2
- id: number;
3
- name: string;
4
- size: number;
5
- md5: string;
6
- url: string;
7
- version: number;
8
- root_id?: number;
9
- };
@@ -1,15 +0,0 @@
1
- export type Bot = {
2
- id: number;
3
- name: string;
4
- external_id?: string;
5
- is_enabled: boolean;
6
- fired?: boolean;
7
- hook_url: string;
8
- description: string;
9
- bot_settings: string;
10
- version: string;
11
- login: string;
12
- send_only_last_comment: boolean;
13
- locale?: string;
14
- time_zone_offset?: number;
15
- };
@@ -1,9 +0,0 @@
1
- export type CatalogHeader = {
2
- name: string;
3
- type: CatalogHeaderType;
4
- };
5
- declare enum CatalogHeaderType {
6
- Text = "text",
7
- Workflow = "workflow"
8
- }
9
- export {};
@@ -1,19 +0,0 @@
1
- import { SourceType } from "../enums/sourceType";
2
- import { ColumnSettings } from "./columnSettings";
3
- export type CatalogInfo = {
4
- catalog_id: number;
5
- name: number;
6
- source_type: SourceType;
7
- external_id?: string;
8
- version: number;
9
- external_version?: number;
10
- deleted: boolean;
11
- supervisors?: number[];
12
- column_settings?: ColumnSettings[];
13
- links?: CatalogLink[];
14
- };
15
- type CatalogLink = {
16
- catalog_id: number;
17
- column_name: string;
18
- };
19
- export {};
@@ -1,12 +0,0 @@
1
- export type CatalogItem = {
2
- item_id?: number;
3
- external_id?: number;
4
- values: string[];
5
- deleted?: boolean;
6
- links?: CatalogItemLink[];
7
- };
8
- type CatalogItemLink = {
9
- item_id: number;
10
- catalog_id: number;
11
- };
12
- export {};
@@ -1,8 +0,0 @@
1
- import { ChannelType } from "../enums/channelType";
2
- import { ChannelUser } from "./channelUser";
3
- export type Channel = {
4
- type: ChannelType;
5
- phone?: string;
6
- to?: ChannelUser;
7
- from?: ChannelUser;
8
- };
@@ -1,4 +0,0 @@
1
- export type ChannelUser = {
2
- email?: string;
3
- name?: string;
4
- };
@@ -1,6 +0,0 @@
1
- export type ColumnSettings = {
2
- original_position?: number;
3
- sort_order?: number;
4
- visible?: boolean;
5
- group_by?: boolean;
6
- };
@@ -1,6 +0,0 @@
1
- import { TaskCommentRequest } from "../requests/taskCommentRequest";
2
- export type CommentDescription = {
3
- task_id: number;
4
- previous_note_id: number;
5
- comment: TaskCommentRequest;
6
- };
@@ -1,7 +0,0 @@
1
- export type Department = {
2
- id: number;
3
- parent_id?: number;
4
- manager_id?: number;
5
- department_name?: string;
6
- external_id?: number;
7
- };
@@ -1,3 +0,0 @@
1
- export type DueFilter = {
2
- overdue_steps: number[];
3
- };
@@ -1,21 +0,0 @@
1
- import { FormField } from "./formFields/formField";
2
- export type FormFieldInfo = {
3
- required_step?: number;
4
- immutable_step?: number;
5
- options?: ChoiceOption[];
6
- catalog_id?: number;
7
- columns?: FormField[];
8
- fields?: FormField[];
9
- form_id?: number;
10
- code?: string;
11
- decimal_places?: number;
12
- multiple_choice?: boolean;
13
- multiline?: boolean;
14
- };
15
- type ChoiceOption = {
16
- choice_id: number;
17
- choice_value: string;
18
- deleted: boolean;
19
- fields: FormField[];
20
- };
21
- export {};
@@ -1,26 +0,0 @@
1
- import { FormFieldAuthor } from "./formFieldAuthor";
2
- import { FormFieldCatalog } from "./formFieldCatalog";
3
- import { FormFieldCheckmark } from "./formFieldCheckmark";
4
- import { FormFieldCreateDate } from "./formFieldCreateDate";
5
- import { FormFieldDate } from "./formFieldDate";
6
- import { FormFieldDueDate } from "./formFieldDueDate";
7
- import { FormFieldDueDateTime } from "./formFieldDueDateTime";
8
- import { FormFieldEmail } from "./formFieldEmail";
9
- import { FormFieldFile } from "./formFieldFile";
10
- import { FormFieldFlag } from "./formFieldFlag";
11
- import { FormFieldFormLink } from "./formFieldFormLink";
12
- import { FormFieldMoney } from "./formFieldMoney";
13
- import { FormFieldMultipleChoice } from "./formFieldMultipleChoice";
14
- import { FormFieldNewFile } from "./formFieldNewFile";
15
- import { FormFieldNote } from "./formFieldNote";
16
- import { FormFieldNumber } from "./formFieldNumber";
17
- import { FormFieldPerson } from "./formFieldPerson";
18
- import { FormFieldPhone } from "./formFieldPhone";
19
- import { FormFieldProject } from "./formFieldProject";
20
- import { FormFieldStatus } from "./formFieldStatus";
21
- import { FormFieldStep } from "./formFieldStep";
22
- import { FormFieldTable } from "./formFieldTable";
23
- import { FormFieldText } from "./formFieldText";
24
- import { FormFieldTime } from "./formFieldTime";
25
- import { FormFieldTitle } from "./formFieldTitle";
26
- export type FormField = 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;
@@ -1,7 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { Person } from "../person";
3
- import { FormFieldType } from "../../enums/formFieldType";
4
- export type FormFieldAuthor = FormFieldBase & {
5
- type?: FormFieldType.Author;
6
- value?: Person;
7
- };
@@ -1,12 +0,0 @@
1
- import { FormFieldType } from "../../enums/formFieldType";
2
- import { FormFieldInfo } from "../formFieldInfo";
3
- export type FormFieldBase = {
4
- id: number;
5
- type: FormFieldType;
6
- name?: string;
7
- info?: FormFieldInfo;
8
- parent_id?: number;
9
- row_id?: number;
10
- code?: string;
11
- value?: any;
12
- };
@@ -1,15 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { FormFieldType } from "../../enums/formFieldType";
3
- export type FormFieldCatalog = FormFieldBase & {
4
- type?: FormFieldType.Catalog;
5
- value?: Catalog;
6
- };
7
- type Catalog = {
8
- item_id: number;
9
- item_ids?: number[];
10
- item_names?: string[];
11
- headers?: string[];
12
- values?: string[];
13
- rows?: string[][];
14
- };
15
- export {};
@@ -1,7 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { FormFieldType } from "../../enums/formFieldType";
3
- import { Checkmark } from "../../enums/checkmark";
4
- export type FormFieldCheckmark = FormFieldBase & {
5
- type?: FormFieldType.Checkmark;
6
- value?: Checkmark;
7
- };
@@ -1,6 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { FormFieldType } from "../../enums/formFieldType";
3
- export type FormFieldCreateDate = FormFieldBase & {
4
- type?: FormFieldType.CreationDate;
5
- value?: Date;
6
- };
@@ -1,6 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { FormFieldType } from "../../enums/formFieldType";
3
- export type FormFieldDate = FormFieldBase & {
4
- type?: FormFieldType.Date;
5
- value?: Date;
6
- };
@@ -1,6 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { FormFieldType } from "../../enums/formFieldType";
3
- export type FormFieldDueDate = FormFieldBase & {
4
- type?: FormFieldType.DueDate;
5
- value?: Date;
6
- };
@@ -1,6 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { FormFieldType } from "../../enums/formFieldType";
3
- export type FormFieldDueDateTime = FormFieldBase & {
4
- type?: FormFieldType.DueDateTime;
5
- value?: Date;
6
- };
@@ -1,6 +0,0 @@
1
- import { FormFieldBase } from "./formFieldBase";
2
- import { FormFieldType } from "../../enums/formFieldType";
3
- export type FormFieldEmail = FormFieldBase & {
4
- type?: FormFieldType.Email;
5
- value?: string;
6
- };