pyrus-api 1.0.2 → 1.1.0

package/build/types/index.d.ts

@@ -1,51 +1,1403 @@
-export { toDateString, toDateTimeString, toTimeString, } from "./src/helpers/functions";
-export { FilterMask } from "./src/enums/filterMask";
-export { CallEventType } from "./src/enums/callEventType";
-export { SourceType } from "./src/enums/sourceType";
-export { OperatorId } from "./src/enums/operatorId";
-export { ActivityAction } from "./src/enums/activityAction";
-export { ApprovalChoice } from "./src/enums/approvalChoice";
-export { PersonRights } from "./src/enums/personRights";
-export { ListType } from "./src/enums/listType";
-export { ErrorCodeType } from "./src/enums/errorCodeType";
-export { Flag } from "./src/enums/flag";
-export { FormFieldType } from "./src/enums/formFieldType";
-export { PermissionLevel } from "./src/enums/permissionLevel";
-export { PersonType } from "./src/enums/personType";
-export { SendSmsError } from "./src/enums/sendSmsError";
-export { SendSmsStatus } from "./src/enums/sendSmsStatus";
-export type { NewFile } from "./src/entities/newFile";
-export type { FormMapping } from "./src/entities/formMapping";
-export type { CatalogItem } from "./src/entities/catalogItem";
-export type { ColumnSettings } from "./src/entities/columnSettings";
-export type { DueFilter } from "./src/entities/dueFilter";
-export type { FormFilter } from "./src/requests/formFilter";
-export type { CommentDescription } from "./src/entities/commentDescription";
-export type { Channel } from "./src/entities/channel";
-export type { PersonIdentity } from "./src/requests/personIdentity";
-export type { FormFieldAuthor } from "./src/entities/formFields/formFieldAuthor";
-export type { FormFieldCatalog } from "./src/entities/formFields/formFieldCatalog";
-export type { FormFieldCheckmark } from "./src/entities/formFields/formFieldCheckmark";
-export type { FormFieldCreateDate } from "./src/entities/formFields/formFieldCreateDate";
-export type { FormFieldDate } from "./src/entities/formFields/formFieldDate";
-export type { FormFieldDueDate } from "./src/entities/formFields/formFieldDueDate";
-export type { FormFieldDueDateTime } from "./src/entities/formFields/formFieldDueDateTime";
-export type { FormFieldEmail } from "./src/entities/formFields/formFieldEmail";
-export type { FormFieldFile } from "./src/entities/formFields/formFieldFile";
-export type { FormFieldFlag } from "./src/entities/formFields/formFieldFlag";
-export type { FormFieldFormLink } from "./src/entities/formFields/formFieldFormLink";
-export type { FormFieldMoney } from "./src/entities/formFields/formFieldMoney";
-export type { FormFieldMultipleChoice } from "./src/entities/formFields/formFieldMultipleChoice";
-export type { FormFieldNewFile } from "./src/entities/formFields/formFieldNewFile";
-export type { FormFieldNote } from "./src/entities/formFields/formFieldNote";
-export type { FormFieldNumber } from "./src/entities/formFields/formFieldNumber";
-export type { FormFieldPerson } from "./src/entities/formFields/formFieldPerson";
-export type { FormFieldPhone } from "./src/entities/formFields/formFieldPhone";
-export type { FormFieldProject } from "./src/entities/formFields/formFieldProject";
-export type { FormFieldStatus } from "./src/entities/formFields/formFieldStatus";
-export type { FormFieldStep } from "./src/entities/formFields/formFieldStep";
-export type { FormFieldTable } from "./src/entities/formFields/formFieldTable";
-export type { FormFieldText } from "./src/entities/formFields/formFieldText";
-export type { FormFieldTime } from "./src/entities/formFields/formFieldTime";
-export type { FormFieldTitle } from "./src/entities/formFields/formFieldTitle";
-export { PyrusApiClient } from "./src/api";
+declare module "pyrus-api" {
+	export enum OperatorId {
+		Equals = 1,
+		LessThan = 2,
+		GreaterThan = 3,
+		IsIn = 4,
+		Range = 5,
+		MatchPrefix = 6,
+		IsEmpty = 7
+	}
+	export type FormFilter = {
+		field_id: number;
+		operator_id: OperatorId;
+		values: string[];
+	};
+	export function toDateTimeString(date: Date | string): string;
+	export function toDateString(date: Date | string): string;
+	export function toTimeString(date: Date | string): string;
+	export enum FilterMask {
+		/**
+		 *  Events whose deadline is indicated in UTC+0
+		 */
+		Due = 1,
+		/**
+		 * Tasks whose deadline is indicated by date
+		 * (without reference to timezone)
+		 */
+		DueDate = 2,
+		/**
+		 * Tasks whose deadline at the current step is
+		 * within the selected time period in UTC+0
+		 */
+		DueForCurrentStep = 4,
+		/**
+		 *  Tasks with a programmed reminder
+		 */
+		Reminded = 8
+	}
+	export enum CallEventType {
+		Show = "show"
+	}
+	export enum SourceType {
+		Default = "default",
+		FillTable = "fill_table"
+	}
+	export enum ActivityAction {
+		Finished = "finished",
+		Reopened = "reopened"
+	}
+	export enum ApprovalChoice {
+		Waiting = "waiting",
+		Approved = "approved",
+		Rejected = "rejected",
+		Revoked = "revoked",
+		Acknowledged = "acknowledged"
+	}
+	export enum PersonRights {
+		None = 0,
+		ManageRoles = 1,
+		CanSeeAllTasks = 2,
+		ManagePersonsInOrganization = 4,
+		EditOrganizationProjects = 8,
+		EditOrganizationSettings = 16,
+		DeleteMyTasksAndProjects = 32,
+		CloseDeleteAnnouncements = 64,
+		BillsPayment = 128,
+		InvitePersonsToOrganization = 256,
+		DeleteOtherMembersTasks = 512,
+		ManageIntegrationsAndCatalogs = 1024,
+		CreateAnnouncement = 2048,
+		CanDeleteTaskFlagEquivalent = 544,
+		SupervisorRights = 221,
+		MaxAdditionalRights = 2047,
+		NewOrganizationDefaultRights = 2080,
+		UIOrganizationManager = 277,
+		UIAccountant = 128,
+		UISupervisor = 10,
+		UIConfigurationManager = 1600,
+		UIAdministrator = 2015
+	}
+	export enum ListType {
+		Private = "private",
+		OrganizationWide = "org_wide"
+	}
+	export enum ErrorCodeType {
+		ServerError = "server_error",
+		AuthorizationError = "authorization_error",
+		TokenNotSpecified = "token_not_specified",
+		RevokedToken = "revoked_token",
+		ExpiredToken = "expired_token",
+		InvalidToken = "invalid_token",
+		AccountBlocked = "account_blocked",
+		InvalidCredentials = "invalid_credentials",
+		InvalidApplicationId = "invalid_application_id",
+		InvalidFieldId = "invalid_field_id",
+		InvalidFieldName = "invalid_field_name",
+		InvalidFieldIdName = "invalid_field_id_name",
+		NonUniqueName = "non_unique_name",
+		FieldIdentityMissing = "field_identity_missing",
+		DuplicateField = "duplicate_field",
+		InvalidCatalogId = "invalid_catalog_id",
+		InvalidCatalogItemName = "invalid_catalog_item_name",
+		NonUniqueCatalogItemName = "non_unique_catalog_item_name",
+		InvalidCatalogItemId = "invalid_catalog_item_id",
+		InvalidCatalogItemIdName = "catalog_item_id_name_mismatch",
+		InvalidEmail = "invalid_email",
+		NonUniqueEmail = "non_unique_email",
+		InvalidPersonIdEmail = "invalid_person_id_email",
+		UnrecognizedAttachmentId = "unrecognized_attachment_id",
+		RequiredFieldMissing = "required_field_missing",
+		FieldTypeIsNotSupported = "type_is_not_supported",
+		IncorrectParametersCount = "incorrect_parameters_count",
+		FilterTypeIsNotSupported = "filter_type_is_not_supported",
+		StepFieldDoesNotExists = "step_field_does_not_exists",
+		NoFileInRequest = "no_file_in_request",
+		TooLargeRequestLength = "too_large_request_length",
+		TaskHasNoForm = "task_has_no_form",
+		RequiredParameterMissing = "required_parameter_missing",
+		InvalidValueFormat = "invalid_value_format",
+		InvalidJson = "invalid_json",
+		EmptyBody = "empty_body",
+		TextMissing = "text_missing",
+		FormIdMissing = "form_id_missing",
+		InvalidPersonId = "invalid_person_id",
+		DeletedField = "deleted_field",
+		PersonIdentityMissing = "person_identity_missing",
+		CatalogItemIdMissing = "catalog_identity_missing",
+		FormHasNoTask = "form_has_no_task",
+		EitherDueDateOrDueCanBeSet = "either_due_date_or_due_can_be_set",
+		NegativeDuration = "negative_duration",
+		DurationIsTooLong = "duration_is_too_long",
+		DueMissing = "due_missing",
+		ScheduledDateInPast = "scheduled_date_in_past",
+		CannotAddFormProject = "cannot_add_form_project",
+		FormTemplateCantBeRemovedFromTask = "form_template_cant_be_removed_from_task",
+		TooManyTaskSteps = "too_many_task_steps",
+		TooManyComments = "too_many_comments",
+		InvalidStepNumber = "invalid_step_number",
+		TaskLimitExceeded = "task_limit_exceeded",
+		FieldIsInTable = "field_is_in_table",
+		RequiredTableFieldMissing = "required_table_field_missing",
+		DepartmentCatalogCanNotBeModified = "department_catalog_can_not_be_modified",
+		CatalogDuplicateItems = "catalog_duplicate_rows",
+		EmptyCatalogHeaders = "empty_catalog_headers",
+		CanNotModifyDeletedCatalog = "can_not_modify_deleted_catalog",
+		CatalogDuplicateHeaders = "catalog_duplicate_headers",
+		CanNotModifyFirstColumn = "can_not_modify_first_column",
+		CatalogHeadersItemsMismatch = "catalog_headers_items_mismatch",
+		TooManyCatalogItems = "too_many_catalog_items",
+		CatalogItemMaxLengthExceeded = "catalog_item_max_length_exceeded",
+		SingleValueIsNotSupported = "single_value_is_not_supported",
+		ParticipantLimitExceeded = "participant_limit_exceeded",
+		TableRowsLimitExceeded = "table_rows_limit_exceeded",
+		TextFieldValueLimitExceeded = "text_field_value_limit_exceeded",
+		UnableToEditField = "unable_to_edit_field",
+		EmptyFile = "empty_file",
+		BadMultipartContent = "bad_multipart_content",
+		TooManyDecimalPlaces = "too_many_decimal_places",
+		ExternalCommentEmptyText = "external_comment_empty_text",
+		SenderAddressFieldMissing = "sender_address_field_missing",
+		ExternalCommentRecipientNotFound = "external_comment_recipient_not_found",
+		DefaultMailboxNotFound = "default_mailbox_not_found",
+		CatalogNullValue = "catalog_null_value",
+		MaxTextLengthExceeded = "max_text_length_exceeded",
+		DueOutsideOfBounds = "due_outside_of_bounds",
+		AttachmentsForbidden = "attachments_forbidden",
+		UnrecognizedCallGuid = "unrecognized_call_guid",
+		UnsupportedAttachmentFormat = "unsupported_attachment_format",
+		ValidationError = "validation_error",
+		UnrecognizedAccountId = "unrecognized_account_id",
+		WebhookIsDisabled = "webhook_is_disabled",
+		TooLargeMessageText = "too_large_message_text",
+		UnrecognizedMessageType = "unrecognized_message_type",
+		InvalidFieldMappingCode = "invalid_field_mapping_code",
+		TooManyAttachments = "too_many_attachments",
+		UnrecognizedCallId = "unrecognized_call_id",
+		UnsupportedRecordFileFormat = "unsupported_record_file_format",
+		UnrecognizedIntegrationGuid = "unrecognized_integration_guid",
+		LimitExceeded = "limit_exceeded",
+		MaxSmsTextLengthExceeded = "max_sms_text_length_exceeded",
+		SmsIntegrationNotConfigured = "sms_integration_not_configured",
+		AttachmentTooBig = "attachment_too_big",
+		UncreatedOrDeletedTableRows = "invalid_table_row",
+		PrivateChannelAccessDenied = "private_channel_access_denied",
+		PrivateCommentHasForbiddenChanges = "private_comment_has_forbidden_changes",
+		ItemsCountOutOfRange = "items_count_out_of_range",
+		CannotAddExternalUser = "cannot_add_external_user",
+		UnrecognizedTaskId = "unrecognized_task_id",
+		TooManyDeletedCatalogItems = "too_many_deleted_catalog_items",
+		FieldCannotHaveMultipleValues = "field_cannot_have_multiple_values",
+		FieldEditingIsNotAllowed = "field_editing_is_not_allowed",
+		NonUniqueCode = "non_unique_code",
+		InvalidFieldCode = "invalid_field_code",
+		AccessDeniedProject = "access_denied_project",
+		AccessDeniedTask = "access_denied_task",
+		AccessDeniedCatalog = "access_denied_catalog",
+		AccessDeniedForm = "access_denied_form",
+		AccessDeniedPerson = "access_denied_person",
+		AccessDeniedCloseTask = "access_denied_close_task",
+		AccessDeniedReopenTask = "access_denied_reopen_task",
+		AccessDeniedFileAccessHistory = "access_denied_file_access_history",
+		AccessDeniedFile = "access_denied_file",
+		AccessDeniedReport = "access_denied_report",
+		AccessDenied = "access_denied",
+		FileIsMissing = "file_is_missing",
+		TooManyRequests = "too_many_requests"
+	}
+	export enum Flag {
+		None = "none",
+		Checked = "checked",
+		Unchecked = "unchecked"
+	}
+	export enum FormFieldType {
+		Unknown = "unknown",
+		Text = "text",
+		Money = "money",
+		Number = "number",
+		Date = "date",
+		Time = "time",
+		Checkmark = "checkmark",
+		MultipleChoice = "multiple_choice",
+		DueDate = "due_date",
+		Email = "email",
+		Phone = "phone",
+		Flag = "flag",
+		Step = "step",
+		Status = "status",
+		CreationDate = "creation_date",
+		Note = "note",
+		Catalog = "catalog",
+		File = "file",
+		Person = "person",
+		Author = "author",
+		Table = "table",
+		Title = "title",
+		Project = "project",
+		FormLink = "form_link",
+		DueDateTime = "due_date_time"
+	}
+	export enum PermissionLevel {
+		None = "none",
+		Manager = "manager",
+		Member = "member",
+		Administrator = "administrator"
+	}
+	export enum PersonType {
+		User = "user",
+		Bot = "bot",
+		Role = "role"
+	}
+	export enum SendSmsError {
+		None = "none",
+		Unknown = "unknown",
+		Expired = "expired",
+		Forbidden = "forbidden",
+		Unreachable = "unreachable",
+		UnknownStatus = "unknown_status",
+		UnableToDeliver = "unable_to_deliver",
+		InvalidPhoneNumber = "invalid_phone_number",
+		Rejected = "rejected"
+	}
+	export enum SendSmsStatus {
+		Sent = "sent",
+		Delivered = "delivered",
+		DeliveryFailed = "delivery_failed",
+		SendFailed = "send_failed"
+	}
+	export type NewFile = {
+		guid?: string;
+		root_id?: number;
+		attachment_id?: number;
+		url?: string;
+		name?: string;
+	};
+	/**
+	 * Data for autofilling form fields
+	 */
+	export type FormMapping = {
+		/**
+		 * Pyrus form field symbol code
+		 */
+		code: string;
+		/**
+		 * Pyrus field value
+		 *
+		 * @remarks
+		 * 300 symbols max
+		 */
+		value: string;
+	};
+	export type CatalogItem = {
+		item_id?: number;
+		external_id?: number;
+		values: string[];
+		deleted?: boolean;
+		links?: CatalogItemLink[];
+	};
+	export type CatalogItemLink = {
+		item_id: number;
+		catalog_id: number;
+	};
+	export type ColumnSettings = {
+		original_position?: number;
+		sort_order?: number;
+		visible?: boolean;
+		group_by?: boolean;
+	};
+	export type DueFilter = {
+		overdue_steps: number[];
+	};
+	export type FormFieldInfo = {
+		required_step?: number;
+		immutable_step?: number;
+		options?: ChoiceOption[];
+		catalog_id?: number;
+		columns?: FormField[];
+		fields?: FormField[];
+		form_id?: number;
+		code?: string;
+		decimal_places?: number;
+		multiple_choice?: boolean;
+		multiline?: boolean;
+	};
+	export type ChoiceOption = {
+		choice_id: number;
+		choice_value: string;
+		deleted: boolean;
+		fields: FormField[];
+	};
+	export type FormFieldBase = {
+		id: number;
+		type: FormFieldType;
+		name?: string;
+		info?: FormFieldInfo;
+		parent_id?: number;
+		row_id?: number;
+		code?: string;
+		value?: any;
+	};
+	export type Person = {
+		id: number;
+		first_name: string;
+		last_name: string;
+		native_first_name?: string;
+		native_last_name?: string;
+		email: string;
+		status?: string;
+		type: PersonType;
+		department_id?: string;
+		department_name?: string;
+		banned: boolean;
+		fired?: boolean;
+		task_receiver?: number;
+		position: string;
+		skype: string;
+		phone: string;
+	};
+	export type FormFieldAuthor = FormFieldBase & {
+		type?: FormFieldType.Author;
+		value?: Person;
+	};
+	export type FormFieldCatalog = FormFieldBase & {
+		type?: FormFieldType.Catalog;
+		value?: Catalog;
+	};
+	export type Catalog = {
+		item_id: number;
+		item_ids?: number[];
+		item_names?: string[];
+		headers?: string[];
+		values?: string[];
+		rows?: string[][];
+	};
+	enum Checkmark {
+		Checked = "checked",
+		Unchecked = "unchecked"
+	}
+	export type FormFieldCheckmark = FormFieldBase & {
+		type?: FormFieldType.Checkmark;
+		value?: Checkmark;
+	};
+	export type FormFieldCreateDate = FormFieldBase & {
+		type?: FormFieldType.CreationDate;
+		value?: Date;
+	};
+	export type FormFieldDate = FormFieldBase & {
+		type?: FormFieldType.Date;
+		value?: Date;
+	};
+	export type FormFieldDueDate = FormFieldBase & {
+		type?: FormFieldType.DueDate;
+		value?: Date;
+	};
+	export type FormFieldDueDateTime = FormFieldBase & {
+		type?: FormFieldType.DueDateTime;
+		value?: Date;
+	};
+	export type FormFieldEmail = FormFieldBase & {
+		type?: FormFieldType.Email;
+		value?: string;
+	};
+	export type AttachedFile = {
+		id: number;
+		name: string;
+		size: number;
+		md5: string;
+		url: string;
+		version: number;
+		root_id?: number;
+	};
+	export type FormFieldFile = FormFieldBase & {
+		type?: FormFieldType.File;
+		value?: AttachedFile[];
+	};
+	export type FormFieldFlag = FormFieldBase & {
+		type?: FormFieldType.Flag;
+		value?: Flag;
+	};
+	export type FormLink = {
+		task_id?: number;
+		task_ids?: number[];
+		subject?: string;
+	};
+	export type FormFieldFormLink = FormFieldBase & {
+		type?: FormFieldType.FormLink;
+		value?: FormLink;
+	};
+	export type FormFieldMoney = FormFieldBase & {
+		type?: FormFieldType.Money;
+		value?: number;
+	};
+	export type FormFieldMultipleChoice = FormFieldBase & {
+		type?: FormFieldType.MultipleChoice;
+		value?: MultipleChoice;
+	};
+	export type MultipleChoice = {
+		choice_id?: number;
+		choice_ids?: number[];
+		choice_names?: string[];
+		fields?: FormField[];
+	};
+	export type FormFieldNewFile = FormFieldFile & {
+		value?: NewFile[];
+	};
+	export type FormFieldNote = FormFieldBase & {
+		type?: FormFieldType.Note;
+		value?: string;
+	};
+	export type FormFieldNumber = FormFieldBase & {
+		type?: FormFieldType.Number;
+		value?: number;
+	};
+	export type FormFieldPerson = FormFieldBase & {
+		type?: FormFieldType.Person;
+		value?: Person;
+	};
+	export type FormFieldPhone = FormFieldBase & {
+		type?: FormFieldType.Phone;
+		value?: string;
+	};
+	export type FormFieldProject = FormFieldBase & {
+		type?: FormFieldType.Project;
+		value?: ProjectArray;
+	};
+	export type ProjectArray = {
+		projects: Project[];
+	};
+	export type Project = {
+		id: number;
+		name?: string;
+		parent?: Project;
+	};
+	enum Status {
+		Open = "open",
+		Closed = "closed"
+	}
+	export type FormFieldStatus = FormFieldBase & {
+		type?: FormFieldType.Status;
+		value?: Status;
+	};
+	export type FormFieldStep = FormFieldBase & {
+		type?: FormFieldType.Step;
+		value?: number;
+	};
+	export type FormFieldTable = FormFieldBase & {
+		type?: FormFieldType.Table;
+		value?: TableRow[];
+	};
+	export type TableRow = {
+		row_id: number;
+		cells?: FormField[];
+		delete?: boolean;
+		deleted?: boolean;
+	};
+	export type FormFieldText = FormFieldBase & {
+		type?: FormFieldType.Text;
+		value?: string;
+	};
+	export type FormFieldTime = FormFieldBase & {
+		type?: FormFieldType.Time;
+		value?: Date;
+	};
+	export type FormFieldTitle = FormFieldBase & {
+		type?: FormFieldType.Title;
+		value?: Title;
+	};
+	export type Title = {
+		checkmark?: Checkmark;
+		fields?: FormField[];
+	};
+	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;
+	enum ChannelType {
+		Email = "email",
+		Telegram = "telegram",
+		Web = "web",
+		Facebook = "facebook",
+		Vk = "vk",
+		Viber = "viber",
+		MobileApp = "mobile_app",
+		WebWidget = "web_widget",
+		MoySklad = "moy_sklad",
+		Zadarma = "zadarma",
+		AmoCrm = "amo_crm",
+		Instagram = "instagram",
+		PrivateChannel = "private_channel",
+		Jira = "jira",
+		Beeline = "beeline",
+		ApiTelephony = "api_telephony",
+		Zoom = "zoom",
+		WebForm = "web_form",
+		WhatsApp = "whats_app",
+		Custom = "custom",
+		Sms = "sms"
+	}
+	export type ChannelUser = {
+		email?: string;
+		name?: string;
+	};
+	export type Channel = {
+		type: ChannelType;
+		phone?: string;
+		to?: ChannelUser;
+		from?: ChannelUser;
+	};
+	export type PersonIdentity = {
+		id: number;
+	} | {
+		email: string;
+	};
+	export type TaskCommentRequest = {
+		text?: string;
+		formatted_text?: string;
+		subject?: string;
+		approval_choice?: ApprovalChoice;
+		reassign_to?: PersonIdentity;
+		approval_steps?: number[];
+		action?: ActivityAction;
+		attachments?: NewFile[];
+		field_updates?: FormField[];
+		approvals_added?: PersonIdentity[][];
+		approvals_removed?: PersonIdentity[][];
+		approvals_rerequested?: PersonIdentity[][];
+		subscribers_added?: PersonIdentity[];
+		subscribers_removed?: PersonIdentity[];
+		subscribers_rerequested?: PersonIdentity[];
+		participants_added?: PersonIdentity[];
+		participants_removed?: PersonIdentity[];
+		due_date?: Date;
+		due?: Date;
+		duration?: number;
+		cancel_due?: boolean;
+		scheduled_date?: Date;
+		scheduled_datetime_utc?: Date;
+		cancel_schedule?: boolean;
+		added_list_ids?: number[];
+		removed_list_ids?: number[];
+		channel?: Channel;
+		spent_minutes?: number;
+		skip_satisfaction?: boolean;
+		edit_comment_id?: number;
+		skip_notification?: boolean;
+	};
+	export type CommentDescription = {
+		task_id: number;
+		previous_note_id: number;
+		comment: TaskCommentRequest;
+	};
+	export type ResponseBase = {
+		error?: string;
+		error_code?: ErrorCodeType;
+		error_message?: string;
+	};
+	export type Approval = {
+		person: Person;
+		approval_choice?: ApprovalChoice;
+		step?: number;
+	};
+	export type Subscriber = {
+		person: Person;
+		approval_choice?: ApprovalChoice;
+	};
+	export type TaskHeader = {
+		id: number;
+		text: string;
+		create_date: Date;
+		last_modified_date: Date;
+		author: Person;
+		close_date?: Date;
+		responsible?: Person;
+		due_date?: Date;
+	};
+	export type Task = TaskHeader & {
+		due_date?: Date;
+		due?: Date;
+		scheduled_date?: Date;
+		scheduled_datetime_utc?: Date;
+		cancel_schedule?: boolean;
+		duration?: number;
+		form_id?: number;
+		attachments?: AttachedFile[];
+		fields?: FormField[];
+		approvals?: Approval[][];
+		subscribers?: Subscriber[];
+		participants?: Person[];
+		list_ids?: number[];
+		linked_task_ids?: number[];
+		parent_task_id?: number;
+		last_note_id?: number;
+		subject?: string;
+		is_closed: boolean;
+	};
+	export type Role = {
+		id: number;
+		name: string;
+		external_id?: string;
+		avatar_id?: number;
+		external_avatar_id?: number;
+		banned: boolean;
+		fired?: boolean;
+		member_ids: number[];
+	};
+	export type SmsInfo = {
+		error_code?: SendSmsError;
+		status: SendSmsStatus;
+		error_message?: string;
+		sent_comment_id: number;
+	};
+	export type TaskComment = {
+		id: number;
+		text: string;
+		formatted_text?: string;
+		mentions?: number[];
+		subject?: string;
+		create_date: Date;
+		author: Person;
+		reassigned_to?: Person;
+		field_updates?: FormField[];
+		approval_choice?: ApprovalChoice;
+		reset_to_step?: number;
+		reply_note_id?: number;
+		approvals_added?: Approval[][];
+		approvals_removed?: Approval[][];
+		approvals_rerequested?: Approval[][];
+		subscribers_added?: Person[];
+		subscribers_removed?: Person[];
+		participants_added?: Person[];
+		participants_removed?: Person[];
+		due_date?: Date;
+		due?: Date;
+		scheduled_date?: Date;
+		scheduled_datetime_utc?: Date;
+		cancel_schedule?: boolean;
+		duration?: number;
+		attachments?: AttachedFile[];
+		action?: ActivityAction;
+		added_list_ids?: number[];
+		removed_list_ids?: number[];
+		approval_step?: number;
+		comment_as_roles?: Role[];
+		changed_step?: number;
+		channel?: Channel;
+		edit_comment_id?: number;
+		removed_attachment_ids?: number[];
+		delete_comment_id?: number;
+		spent_minutes?: number;
+		skip_satisfaction?: boolean;
+		sms_info?: SmsInfo;
+	};
+	export type Step = {
+		step: number;
+		elapsed_time: number;
+		name?: string;
+	};
+	export type TaskWithComments = Task & {
+		comments: TaskComment[];
+		steps?: Step[];
+	};
+	export type TaskResponse = ResponseBase & {
+		task: TaskWithComments;
+	};
+	export type BotHookRequest = {
+		event: "Comment" | "Close";
+		access_token: string;
+		user_id: number;
+		bot_settings: string;
+		task_id: number;
+		task: TaskResponse;
+	};
+	export type BotHookResponse = TaskCommentRequest | void;
+	export type AuthRequest = {
+		login: string;
+		security_key: string;
+		/**
+		 * Employee ID
+		 * @remarks
+		 *  if you have more than one account registered to the same email,
+		 *  then to receive a token you need to add the person_id parameter
+		 */
+		person_id?: string;
+	};
+	export type Settings = {
+		apiUrl?: string;
+		authUrl: string;
+		filesUrl?: string;
+	};
+	export type AuthResponse = ResponseBase & {
+		access_token: string;
+		api_url?: string;
+		files_url?: string;
+	};
+	export type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE";
+	export type ById = {
+		id: number;
+	};
+	export interface BaseApiParams {
+		token?: string;
+		settings?: Settings;
+		authRequest?: Promise<AuthResponse>;
+	}
+	abstract class BaseApi {
+		protected _token: string;
+		protected _settings: Settings;
+		protected _authRequest: Promise<AuthResponse>;
+		protected _moduleSubPath: string;
+		protected constructor({ token, authRequest, settings }: BaseApiParams);
+		protected loginDone(): Promise<void>;
+		protected fetchApi<T>(url: string, method: HTTPMethod, body?: BodyInit, headersOverride?: HeadersInit): Promise<T>;
+		protected _checkResponse(resp: Response): Promise<any>;
+		protected getModulePath(): Promise<string>;
+		protected authorisationHeader(): Promise<Record<string, string>>;
+		private defaultHeaders;
+	}
+	export type CreateRoleRequest = {
+		name: string;
+		external_id?: string;
+		member_add?: number[];
+	};
+	enum Endpoints {
+		Auth = "/auth",
+		Roles = "/roles",
+		Profile = "/profile",
+		Contacts = "/contacts",
+		Files = "/files",
+		V4 = "/v4",
+		Upload = "/upload",
+		Download = "/download",
+		Lists = "/lists",
+		Inbox = "/inbox",
+		ListTasks = "/tasks",
+		Calendar = "/calendar",
+		Announcements = "/announcements",
+		AnnouncementComments = "/comments",
+		Catalogs = "/catalogs",
+		Members = "/members",
+		Tasks = "/tasks",
+		TasksComments = "/comments",
+		Forms = "/forms",
+		FormsRegister = "/register",
+		FormsPermissions = "/permissions",
+		EventHistory = "/eventhistory",
+		FileAccessHistory = "/fileaccesshistory",
+		TaskAccessHistory = "/taskaccesshistory",
+		TaskExportHistory = "/taskexporthistory",
+		RegistryDownloadHistory = "/registrydownloadhistory",
+		Integrations = "/integrations",
+		Call = "/call",
+		AttachCallRecord = "/attachcallrecord",
+		Bots = "/bots"
+	}
+	export type RoleResponse = ResponseBase & Role;
+	export type RolesResponse = ResponseBase & {
+		roles: Role[];
+	};
+	export type UpdateRoleRequest = {
+		id: number;
+		name?: string;
+		external_id?: string;
+		banned?: boolean;
+		member_add?: number[];
+		member_remove?: number[];
+	};
+	export type GetAllRequest = {
+		include_fired: boolean;
+	};
+	class RoleApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		create(request: CreateRoleRequest): Promise<RoleResponse>;
+		get({ id }: ById): Promise<RoleResponse>;
+		getAll(request?: GetAllRequest): Promise<RolesResponse>;
+		update(request: UpdateRoleRequest): Promise<RoleResponse>;
+	}
+	export type Organization = {
+		organization_id: number;
+		name: string;
+		persons: Person[];
+		roles: Role[];
+		department_catalog_id?: number;
+	};
+	export type ProfileResponse = ResponseBase & {
+		person_id: number;
+		first_name?: string;
+		last_name?: string;
+		email: string;
+		locale?: string;
+		organization_id: number;
+		organization: Organization;
+		timezone_offset?: number;
+	};
+	export type ProfileRequest = {
+		include_inactive: boolean;
+	};
+	class ProfileApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		get(request?: ProfileRequest): Promise<ProfileResponse>;
+	}
+	export type ContactsRequest = {
+		include_inactive?: boolean;
+	};
+	export type ContactsResponse = ResponseBase & {
+		organizations: Organization[];
+	};
+	class ContactsApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		getAll(request?: ContactsRequest): Promise<ContactsResponse>;
+	}
+	export type UploadResponse = ResponseBase & {
+		guid: string;
+		md5_hash: string;
+	};
+	class FilesApi extends BaseApi {
+		upload(file: Blob, filename: string): Promise<UploadResponse>;
+		download({ id }: ById): Promise<Blob>;
+		private _filePath;
+	}
+	export type PlainTaskList = {
+		id: number;
+		parent_id?: number;
+		name: string;
+		color?: string;
+		deleted: boolean;
+		list_type: ListType;
+		has_form?: boolean;
+		manager_ids: number[];
+		member_ids?: number[];
+		version: number;
+		external_version?: number;
+		external_id?: number;
+	};
+	export type TaskList = PlainTaskList & {
+		children?: TaskList[];
+	};
+	export type ListsResponse = ResponseBase & {
+		lists: TaskList[];
+	};
+	export type TaskListRequest = {
+		include_archived?: "y";
+		modified_before?: Date;
+		modified_after?: Date;
+		/**
+		 * @remarks
+		 * Default: 200
+		 */
+		item_count?: number;
+	};
+	export type TaskListResponse = ResponseBase & {
+		tasks: TaskHeader[];
+		has_more: boolean;
+	};
+	export type InboxRequest = {
+		/**
+		 * The maximum number of tasks in the response
+		 * @remarks
+		 * default: 50
+		 */
+		item_count: number;
+	};
+	export type CreateListRequest = {
+		parent_id?: number;
+		name: string;
+		color?: string;
+		list_type?: ListType;
+		added_managers?: number[];
+		added_members?: number[];
+		external_version?: number;
+		external_id?: number;
+		is_private?: boolean;
+	};
+	export type PlainListResponse = ResponseBase & PlainTaskList;
+	export type UpdateListRequest = {
+		id: number;
+		name?: string;
+		color?: string;
+		list_type?: ListType;
+		added_managers?: number[];
+		removed_managers?: number[];
+		added_members?: number[];
+		removed_members?: number[];
+		external_version?: number;
+		external_id?: number;
+		is_private?: boolean;
+	};
+	class ListsApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		getAll(): Promise<ListsResponse>;
+		getTasksInList(listId: number, request?: TaskListRequest): Promise<TaskListResponse>;
+		getInbox(request?: InboxRequest): Promise<TaskListResponse>;
+		create(request: CreateListRequest): Promise<PlainListResponse>;
+		delete(request: ById): Promise<ResponseBase>;
+		update(request: UpdateListRequest): Promise<PlainListResponse>;
+	}
+	export type CalendarTasksRequest = {
+		start_date_utc?: Date;
+		end_date_utc: Date;
+		/**
+		 * Maximum number of tasks that will be returned in reply
+		 * @remarks
+		 * 50 default, 100 max
+		 */
+		item_count?: number;
+		/**
+		 * @remarks
+		 * Whether all tasks accessible to user must be returned,
+		 * including all roles of user and all tasks from forms
+		 * accessible to user. Otherwise, only tasks where the user
+		 * is an assignee or approver, that have not yet been approved,
+		 * will be returned.
+		 */
+		all_accessed_tasks?: boolean;
+		/**
+		 * Bit mask that determines filter combination
+		 */
+		filter_mask?: FilterMask;
+	};
+	export type CalendarResponse = ResponseBase & {
+		tasks: TaskWithComments[];
+		has_more: boolean;
+	};
+	class CalendarApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		getTasks(request: CalendarTasksRequest): Promise<CalendarResponse>;
+	}
+	export type AnnouncementComment = {
+		id: number;
+		text?: string;
+		formatted_text?: string;
+		create_date: Date;
+		author: Person;
+		attachments?: AttachedFile[];
+		comments?: TaskComment[];
+	};
+	export type AnnouncementWithComments = {
+		id: number;
+		text: string;
+		formatted_text: string;
+		create_date: Date;
+		last_modified_date: Date;
+		author: Person;
+		attachments?: AttachedFile[];
+		comments?: AnnouncementComment[];
+	};
+	export type AnnouncementsResponse = ResponseBase & {
+		announcements: AnnouncementWithComments[];
+	};
+	export type AnnouncementResponse = ResponseBase & {
+		announcement: AnnouncementWithComments;
+	};
+	export type AnnouncementRequest = {
+		text: string;
+		formatted_text?: string;
+		attachments?: NewFile[];
+	};
+	export type AnnouncementCommentRequest = {
+		text?: string;
+		formatted_text?: string;
+		attachments?: NewFile[];
+	};
+	class AnnouncementsApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		getAll(): Promise<AnnouncementsResponse>;
+		get({ id }: ById): Promise<AnnouncementResponse>;
+		create(request: AnnouncementRequest): Promise<AnnouncementResponse>;
+		addComment(id: number, request: AnnouncementCommentRequest): Promise<AnnouncementResponse>;
+	}
+	export type CatalogInfo = {
+		catalog_id: number;
+		name: number;
+		source_type: SourceType;
+		external_id?: string;
+		version: number;
+		external_version?: number;
+		deleted: boolean;
+		supervisors?: number[];
+		column_settings?: ColumnSettings[];
+		links?: CatalogLink[];
+	};
+	export type CatalogLink = {
+		catalog_id: number;
+		column_name: string;
+	};
+	export type CatalogsResponse = ResponseBase & {
+		catalogs: CatalogInfo[];
+	};
+	export type CatalogHeader = {
+		name: string;
+		type: CatalogHeaderType;
+	};
+	enum CatalogHeaderType {
+		Text = "text",
+		Workflow = "workflow"
+	}
+	export type CatalogItemResponse = CatalogItem & {
+		item_id: number;
+	};
+	export type CatalogResponse = ResponseBase & {
+		catalog_id: number;
+		name: string;
+		external_id?: string;
+		version: number;
+		external_version?: number;
+		deleted: boolean;
+		supervisors?: number[];
+		catalog_headers: CatalogHeader[];
+		column_settings?: ColumnSettings[];
+		items?: CatalogItemResponse[];
+		source_type: SourceType;
+	};
+	export type CatalogRequestBase = {
+		id?: number;
+		external_id?: string;
+		name?: string;
+		external_version?: number;
+		catalog_headers: string[];
+		items?: CatalogItem[];
+		add_supervisors?: number[];
+		remove_supervisors?: number[];
+		add_workflow_headers?: string[];
+		delete_workflow_headers?: string[];
+		column_settings?: ColumnSettings[];
+	};
+	export type CreateCatalogRequest = CatalogRequestBase & {
+		name: string;
+		source_type?: SourceType;
+	};
+	export type SyncCatalogRequest = CatalogRequestBase & {
+		id: number;
+		apply: boolean;
+		force_update_first_column?: boolean;
+	};
+	export type SyncCatalogResponse = ResponseBase & {
+		apply: boolean;
+		added?: CatalogItemResponse[];
+		deleted?: CatalogItemResponse[];
+		updated?: CatalogItemResponse[];
+		catalog_headers: CatalogHeader[];
+	};
+	class CatalogsApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		getAll(): Promise<CatalogsResponse>;
+		get({ id }: ById): Promise<CatalogResponse>;
+		create(request: CreateCatalogRequest): Promise<CatalogResponse>;
+		/**
+		 *  This method updates catalog headers and items.
+		 *  You must define all the values and text columns that need to remain in the catalog.
+		 *
+		 *  All unspecified items and text columns will be deleted
+		 * @param request
+		 */
+		sync(request: SyncCatalogRequest): Promise<SyncCatalogResponse>;
+	}
+	export type MembersResponse = ResponseBase & {
+		members: Person[];
+	};
+	export type MemberResponse = ResponseBase & Person;
+	export type CreateMemberRequest = {
+		first_name?: string;
+		last_name?: string;
+		email: string;
+		status?: string;
+		position?: string;
+		department_id?: number;
+		skype?: string;
+		phone?: string;
+		external_id?: string;
+		login_phone?: string;
+	};
+	export type UpdateMemberRequest = {
+		id: number;
+		first_name?: string;
+		last_name?: string;
+		native_first_name?: string;
+		native_last_name?: string;
+		email?: string;
+		status?: string;
+		banned?: boolean;
+		position?: string;
+		department_id?: number;
+		drop_department?: boolean;
+		skype?: string;
+		phone?: string;
+	};
+	class MembersApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		/**
+		 *
+		 * @param request
+		 * "email" and one of "first_name" or "last_name" are required
+		 */
+		create(request: CreateMemberRequest): Promise<MemberResponse>;
+		get({ id }: ById): Promise<MemberResponse>;
+		getAll(request?: GetAllRequest): Promise<MembersResponse>;
+		update(request: UpdateMemberRequest): Promise<MemberResponse>;
+		delete({ id }: ById): Promise<MemberResponse>;
+	}
+	export type TaskRequest = {
+		text?: string;
+		formatted_text?: string;
+		subject?: string;
+		parent_task_id?: number;
+		due_date?: Date;
+		due?: Date;
+		scheduled_date?: Date;
+		scheduled_datetime_utc?: Date;
+		cancel_schedule?: boolean;
+		duration?: number;
+		form_id?: number;
+		attachments?: NewFile[];
+		responsible?: PersonIdentity;
+		fields?: FormField[];
+		approvals?: PersonIdentity[][];
+		subscribers?: PersonIdentity[];
+		participants?: PersonIdentity[];
+		list_ids?: number[];
+		fill_defaults?: boolean;
+	};
+	class TasksApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		get({ id }: ById): Promise<TaskResponse>;
+		/**
+		 *
+		 * @param request
+		 * If "form_id" specified it will be Form task,
+		 * else - Simple task.
+		 */
+		create(request: TaskRequest): Promise<TaskResponse>;
+		addComment(id: number, request: TaskCommentRequest): Promise<TaskResponse>;
+	}
+	export type PrintForm = {
+		print_form_id: number;
+		print_form_name?: string;
+	};
+	export type FormResponse = ResponseBase & {
+		id: number;
+		name: string;
+		steps?: TaskSteps;
+		fields: FormField[];
+		print_forms?: PrintForm[];
+		deleted_or_closed: boolean;
+		business_owners?: number[];
+		folder?: string[];
+	};
+	export type TaskSteps = {
+		[index: number]: string;
+	};
+	export type FormsResponse = {
+		forms: FormResponse[];
+	};
+	export type FormRegisterRequest = {
+		steps?: number[];
+		include_archived?: "y";
+		modified_before?: Date;
+		modified_after?: Date;
+		created_before?: Date;
+		created_after?: Date;
+		closed_before?: Date;
+		closed_after?: Date;
+		filters?: FormFilter[];
+		format?: "csv";
+		delimiter?: string;
+		simple_format?: boolean;
+		encoding?: string;
+		field_ids?: number[];
+		task_ids?: number[];
+		due_filter?: DueFilter;
+		/**
+		 * Max. number of tasks in request
+		 * @remarks
+		 * More than 0, and less than or equal to 20000
+		 */
+		item_count?: number;
+	};
+	export type FormRegisterResponse = ResponseBase & {
+		tasks: Task[];
+	};
+	export type PermissionsDict = {
+		[index: string | number]: PermissionLevel;
+	};
+	export type PermissionsResponse = ResponseBase & {
+		permissions: PermissionsDict;
+	};
+	export type ChangePermissionsRequest = {
+		permissions: PermissionsDict;
+	};
+	class FormsApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		get({ id }: ById): Promise<FormResponse>;
+		getAll(): Promise<FormsResponse>;
+		getTasks(id: number, request: FormRegisterRequest): Promise<FormRegisterResponse>;
+		getPermissions({ id }: ById): Promise<PermissionsResponse>;
+		setPermissions(id: number, request: ChangePermissionsRequest): Promise<PermissionsResponse>;
+	}
+	export type LogsParameters = {
+		after?: number;
+		count?: number;
+	};
+	class LogsApi extends BaseApi {
+		getEvents(request?: LogsParameters): Promise<Blob>;
+		getFileAccess(request?: LogsParameters): Promise<Blob>;
+		getTaskAccess(request?: LogsParameters): Promise<Blob>;
+		getTaskExport(request?: LogsParameters): Promise<Blob>;
+		getRegistryDownload(request?: LogsParameters): Promise<Blob>;
+	}
+	export type CallRequest = {
+		/**
+		 * Unique ID of the extension's account in the external system
+		 */
+		account_id: string;
+		/**
+		 * Sender phone number
+		 */
+		from_number: string;
+		/**
+		 * Recipient phone number
+		 */
+		to_number: string;
+		/**
+		 * Internal operator number
+		 */
+		internal_number?: string;
+		/**
+		 * Call ID in external system
+		 */
+		external_id?: string;
+		/**
+		 * Data for autofill form fields
+		 */
+		mappings?: FormMapping[];
+	};
+	export type CallResponse = ResponseBase & {
+		task_id: number;
+	};
+	/**
+	 * Adding information about the call
+	 *
+	 * @remarks
+	 *
+	 * To successfully process the request, one of the following parameters
+	 * must be indicated: external_id, task_id or from_number and to_number
+	 */
+	export type AttachCallRecordRequest = {
+		/**
+		 *  Unique ID of the file uploaded with a /files/upload request
+		 */
+		record_file?: string;
+		/**
+		 * Sender phone number
+		 */
+		from_number?: string;
+		/**
+		 * Recipient phone number
+		 */
+		to_number?: string;
+		/**
+		 * Call ID in external system
+		 */
+		external_id?: string;
+		/**
+		 *  ID of the created task
+		 *  @remarks
+		 *  Returns to integrations/call.
+		 */
+		task_id?: number;
+		/**
+		 * Data for autofill form fields
+		 */
+		mappings?: FormMapping[];
+	};
+	class CallApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		registerCall(request: CallRequest): Promise<CallResponse>;
+		attachCallRecord(request: AttachCallRecordRequest): Promise<ResponseBase>;
+	}
+	export type CreateBotRequest = {
+		name: string;
+		hook_url?: string;
+		external_id?: string;
+	};
+	export type Bot = {
+		id: number;
+		name: string;
+		external_id?: string;
+		is_enabled: boolean;
+		fired?: boolean;
+		hook_url: string;
+		description: string;
+		bot_settings: string;
+		version: string;
+		login: string;
+		send_only_last_comment: boolean;
+		locale?: string;
+		time_zone_offset?: number;
+	};
+	export type BotResponse = ResponseBase & Bot;
+	export type BotsResponse = ResponseBase & {
+		bots: Bot[];
+	};
+	export type UpdateBotRequest = {
+		id: number;
+		name?: string;
+		hook_url?: string;
+		is_enabled?: boolean;
+		bot_settings?: string;
+		description?: string;
+		rights?: PersonRights;
+		send_only_last_comment?: boolean;
+		locale?: string;
+		time_zone_offset?: number;
+	};
+	export type DeleteBotRequest = {
+		id: number;
+		task_receiver_id: number;
+	};
+	class BotApi extends BaseApi {
+		protected _moduleSubPath: Endpoints;
+		create(request: CreateBotRequest): Promise<BotResponse>;
+		get({ id }: ById): Promise<BotResponse>;
+		getAll(request?: GetAllRequest): Promise<BotsResponse>;
+		update(request: UpdateBotRequest): Promise<BotResponse>;
+		delete(request: DeleteBotRequest): Promise<BotResponse>;
+	}
+	export class PyrusApiClient extends BaseApi {
+		private _role;
+		private _profile;
+		private _contacts;
+		private _files;
+		private _lists;
+		private _calendar;
+		private _announcements;
+		private _catalogs;
+		private _members;
+		private _tasks;
+		private _forms;
+		private _logs;
+		private _call;
+		private _bot;
+		/**
+		 *
+		 * @param auth
+		 * can be AuthRequest type or token
+		 * @param settings
+		 * connection settings
+		 */
+		constructor(auth: AuthRequest | string, settings?: Settings);
+		private _authenticateClient;
+		private get initParams();
+		get role(): RoleApi;
+		get profile(): ProfileApi;
+		get contacts(): ContactsApi;
+		get files(): FilesApi;
+		get lists(): ListsApi;
+		get calendar(): CalendarApi;
+		get announcements(): AnnouncementsApi;
+		get catalogs(): CatalogsApi;
+		get members(): MembersApi;
+		get tasks(): TasksApi;
+		get forms(): FormsApi;
+		get logs(): LogsApi;
+		get call(): CallApi;
+		get bot(): BotApi;
+	}
+	
+	export {};
+	
+}