pyrus-api 1.0.2 → 1.1.0

package/build/types/src/enums/formFieldType.d.ts

@@ -1,27 +0,0 @@
-export declare 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"
-}

package/build/types/src/enums/listType.d.ts

@@ -1,4 +0,0 @@
-export declare enum ListType {
-    Private = "private",
-    OrganizationWide = "org_wide"
-}

package/build/types/src/enums/operatorId.d.ts

@@ -1,9 +0,0 @@
-export declare enum OperatorId {
-    Equals = 1,
-    LessThan = 2,
-    GreaterThan = 3,
-    IsIn = 4,
-    Range = 5,
-    MatchPrefix = 6,
-    IsEmpty = 7
-}

package/build/types/src/enums/permissionLevel.d.ts

@@ -1,6 +0,0 @@
-export declare enum PermissionLevel {
-    None = "none",
-    Manager = "manager",
-    Member = "member",
-    Administrator = "administrator"
-}

package/build/types/src/enums/personRights.d.ts

@@ -1,24 +0,0 @@
-export declare 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
-}

package/build/types/src/enums/personType.d.ts

@@ -1,5 +0,0 @@
-export declare enum PersonType {
-    User = "user",
-    Bot = "bot",
-    Role = "role"
-}

package/build/types/src/enums/sendSmsError.d.ts

@@ -1,11 +0,0 @@
-export declare 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"
-}

package/build/types/src/enums/sendSmsStatus.d.ts

@@ -1,6 +0,0 @@
-export declare enum SendSmsStatus {
-    Sent = "sent",
-    Delivered = "delivered",
-    DeliveryFailed = "delivery_failed",
-    SendFailed = "send_failed"
-}

package/build/types/src/enums/sourceType.d.ts

@@ -1,4 +0,0 @@
-export declare enum SourceType {
-    Default = "default",
-    FillTable = "fill_table"
-}

package/build/types/src/enums/status.d.ts

@@ -1,4 +0,0 @@
-export declare enum Status {
-    Open = "open",
-    Closed = "closed"
-}

package/build/types/src/helpers/constants.d.ts

@@ -1,8 +0,0 @@
-import { FormFieldType } from "../enums/formFieldType";
-export declare const dateTimeFieldTypes: FormFieldType[];
-export declare const dateFieldTypes: FormFieldType[];
-export declare const timeFieldTypes: FormFieldType[];
-export declare const allDateAndTimeFieldTypes: FormFieldType[];
-export declare const allDateAndTimeResponseKeys: string[];
-export declare const dateRequestKeys: string[];
-export declare const dateTimeRequestKeys: string[];

package/build/types/src/helpers/functions.d.ts

@@ -1,13 +0,0 @@
-import { FormFilter } from "../requests/formFilter";
-export declare function toSearchParams(request: object): string;
-export declare function extractDates(key: string, value: any): any;
-export declare function packDates(key: string, value: any): any;
-export declare function trimTailingSlash(url: string): string;
-export declare function toDateTimeString(date: Date | string): string;
-export declare function toDateString(date: Date | string): string;
-export declare function toTimeString(date: Date | string): string;
-type Filters = {
-    [index: string]: string;
-};
-export declare function processFilters(filters: FormFilter[] | undefined): Filters;
-export {};

package/build/types/src/helpers/types.d.ts

@@ -1,4 +0,0 @@
-export type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE";
-export type ById = {
-    id: number;
-};

package/build/types/src/requests/announcementCommentRequest.d.ts

@@ -1,6 +0,0 @@
-import { NewFile } from "../entities/newFile";
-export type AnnouncementCommentRequest = {
-    text?: string;
-    formatted_text?: string;
-    attachments?: NewFile[];
-};

package/build/types/src/requests/announcementRequest.d.ts

@@ -1,6 +0,0 @@
-import { NewFile } from "../entities/newFile";
-export type AnnouncementRequest = {
-    text: string;
-    formatted_text?: string;
-    attachments?: NewFile[];
-};

package/build/types/src/requests/attachCallRecordRequest.d.ts

@@ -1,37 +0,0 @@
-import { FormMapping } from "../entities/formMapping";
-/**
- * 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[];
-};

package/build/types/src/requests/authRequest.d.ts

@@ -1,11 +0,0 @@
-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;
-};

package/build/types/src/requests/calendarTasksRequest.d.ts

@@ -1,24 +0,0 @@
-import { FilterMask } from "../enums/filterMask";
-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;
-};

package/build/types/src/requests/callRequest.d.ts

@@ -1,27 +0,0 @@
-import { FormMapping } from "../entities/formMapping";
-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[];
-};

package/build/types/src/requests/catalogRequestBase.d.ts

@@ -1,15 +0,0 @@
-import { CatalogItem } from "../entities/catalogItem";
-import { ColumnSettings } from "../entities/columnSettings";
-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[];
-};

package/build/types/src/requests/changePermissionsRequest.d.ts

@@ -1,4 +0,0 @@
-import { PermissionsDict } from "../responses/permissionsDict";
-export type ChangePermissionsRequest = {
-    permissions: PermissionsDict;
-};

package/build/types/src/requests/contactsRequest.d.ts

@@ -1,3 +0,0 @@
-export type ContactsRequest = {
-    include_inactive?: boolean;
-};

package/build/types/src/requests/createBotRequest.d.ts

@@ -1,5 +0,0 @@
-export type CreateBotRequest = {
-    name: string;
-    hook_url?: string;
-    external_id?: string;
-};

package/build/types/src/requests/createCallRequest.d.ts

@@ -1,6 +0,0 @@
-export type CreateCallRequest = {
-    to: string;
-    from: string;
-    extension: string;
-    integration_guid: string;
-};

package/build/types/src/requests/createCatalogRequest.d.ts

@@ -1,6 +0,0 @@
-import { CatalogRequestBase } from "./catalogRequestBase";
-import { SourceType } from "../enums/sourceType";
-export type CreateCatalogRequest = CatalogRequestBase & {
-    name: string;
-    source_type?: SourceType;
-};

package/build/types/src/requests/createDepartmentRequest.d.ts

@@ -1,6 +0,0 @@
-export type CreateDepartmentRequest = {
-    parent_id?: number;
-    manager_id?: number;
-    department_name: string;
-    external_id?: number;
-};

package/build/types/src/requests/createListRequest.d.ts

@@ -1,12 +0,0 @@
-import { ListType } from "../enums/listType";
-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;
-};

package/build/types/src/requests/createMemberRequest.d.ts

@@ -1,12 +0,0 @@
-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;
-};

package/build/types/src/requests/createRoleRequest.d.ts

@@ -1,5 +0,0 @@
-export type CreateRoleRequest = {
-    name: string;
-    external_id?: string;
-    member_add?: number[];
-};

package/build/types/src/requests/deleteBotRequest.d.ts

@@ -1,4 +0,0 @@
-export type DeleteBotRequest = {
-    id: number;
-    task_receiver_id: number;
-};

package/build/types/src/requests/deleteRoleRequest.d.ts

@@ -1,4 +0,0 @@
-export type DeleteRoleRequest = {
-    id: number;
-    task_receiver_id: number;
-};

package/build/types/src/requests/formFilter.d.ts

@@ -1,6 +0,0 @@
-import { OperatorId } from "../enums/operatorId";
-export type FormFilter = {
-    field_id: number;
-    operator_id: OperatorId;
-    values: string[];
-};

package/build/types/src/requests/formRegisterRequest.d.ts

@@ -1,26 +0,0 @@
-import { DueFilter } from "../entities/dueFilter";
-import { FormFilter } from "./formFilter";
-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;
-};

package/build/types/src/requests/getAllRequest.d.ts

@@ -1,3 +0,0 @@
-export type GetAllRequest = {
-    include_fired: boolean;
-};

package/build/types/src/requests/getMessageRequest.d.ts

@@ -1,10 +0,0 @@
-import { FormMapping } from "../entities/formMapping";
-export type GetMessageRequest = {
-    account_id: string;
-    channel_id: string;
-    sender_name?: string;
-    message_type?: string;
-    message_text: string;
-    mappings?: FormMapping[];
-    attachments?: string[];
-};

package/build/types/src/requests/inboxRequest.d.ts

@@ -1,8 +0,0 @@
-export type InboxRequest = {
-    /**
-     * The maximum number of tasks in the response
-     * @remarks
-     * default: 50
-     */
-    item_count: number;
-};

package/build/types/src/requests/personIdentity.d.ts

@@ -1,4 +0,0 @@
-export type PersonIdentity = {
-    id?: number;
-    email?: string;
-};

package/build/types/src/requests/profileRequest.d.ts

@@ -1,3 +0,0 @@
-export type ProfileRequest = {
-    include_inactive: boolean;
-};

package/build/types/src/requests/setAvatarRequest.d.ts

@@ -1,4 +0,0 @@
-export type SetAvatarRequest = {
-    guid?: string;
-    external_avatar_id?: number;
-};

package/build/types/src/requests/syncCatalogRequest.d.ts

@@ -1,6 +0,0 @@
-import { CatalogRequestBase } from "./catalogRequestBase";
-export type SyncCatalogRequest = CatalogRequestBase & {
-    id: number;
-    apply: boolean;
-    force_update_first_column?: boolean;
-};

package/build/types/src/requests/taskCommentRequest.d.ts

@@ -1,39 +0,0 @@
-import { ActivityAction } from "../enums/activityAction";
-import { NewFile } from "../entities/newFile";
-import { FormField } from "../entities/formFields/formField";
-import { Channel } from "../entities/channel";
-import { ApprovalChoice } from "../enums/approvalChoice";
-import { PersonIdentity } from "./personIdentity";
-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;
-};

package/build/types/src/requests/taskListRequest.d.ts

@@ -1,10 +0,0 @@
-export type TaskListRequest = {
-    include_archived?: "y";
-    modified_before?: Date;
-    modified_after?: Date;
-    /**
-     * @remarks
-     * Default: 200
-     */
-    item_count?: number;
-};

package/build/types/src/requests/taskRequest.d.ts

@@ -1,24 +0,0 @@
-import { FormField } from "../entities/formFields/formField";
-import { NewFile } from "../entities/newFile";
-import { PersonIdentity } from "./personIdentity";
-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;
-};

package/build/types/src/requests/updateBotRequest.d.ts

@@ -1,13 +0,0 @@
-import { PersonRights } from "../enums/personRights";
-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;
-};

package/build/types/src/requests/updateDepartmentRequest.d.ts

@@ -1,8 +0,0 @@
-export type UpdateDepartmentRequest = {
-    id: number;
-    remove_manager: boolean;
-    parent_id?: number;
-    manager_id?: number;
-    department_name?: string;
-    external_id?: number;
-};

package/build/types/src/requests/updateListRequest.d.ts

@@ -1,14 +0,0 @@
-import { ListType } from "../enums/listType";
-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;
-};

package/build/types/src/requests/updateMemberRequest.d.ts

@@ -1,15 +0,0 @@
-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;
-};

package/build/types/src/requests/updateRoleRequest.d.ts

@@ -1,8 +0,0 @@
-export type UpdateRoleRequest = {
-    id: number;
-    name?: string;
-    external_id?: string;
-    banned?: boolean;
-    member_add?: number[];
-    member_remove?: number[];
-};

package/build/types/src/responses/announcementResponse.d.ts

@@ -1,5 +0,0 @@
-import { ResponseBase } from "./responseBase";
-import { AnnouncementWithComments } from "../entities/announcementWithComments";
-export type AnnouncementResponse = ResponseBase & {
-    announcement: AnnouncementWithComments;
-};

package/build/types/src/responses/announcementsResponse.d.ts

@@ -1,5 +0,0 @@
-import { ResponseBase } from "./responseBase";
-import { AnnouncementWithComments } from "../entities/announcementWithComments";
-export type AnnouncementsResponse = ResponseBase & {
-    announcements: AnnouncementWithComments[];
-};

package/build/types/src/responses/authResponse.d.ts

@@ -1,6 +0,0 @@
-import { ResponseBase } from "./responseBase";
-export type AuthResponse = ResponseBase & {
-    access_token: string;
-    api_url?: string;
-    files_url?: string;
-};

package/build/types/src/responses/botResponse.d.ts

@@ -1,3 +0,0 @@
-import { ResponseBase } from "./responseBase";
-import { Bot } from "../entities/bot";
-export type BotResponse = ResponseBase & Bot;

package/build/types/src/responses/botsResponse.d.ts

@@ -1,5 +0,0 @@
-import { ResponseBase } from "./responseBase";
-import { Bot } from "../entities/bot";
-export type BotsResponse = ResponseBase & {
-    bots: Bot[];
-};

package/build/types/src/responses/calendarResponse.d.ts

@@ -1,6 +0,0 @@
-import { ResponseBase } from "./responseBase";
-import { TaskWithComments } from "../entities/TaskWithComments";
-export type CalendarResponse = ResponseBase & {
-    tasks: TaskWithComments[];
-    has_more: boolean;
-};

package/build/types/src/responses/callResponse.d.ts

@@ -1,4 +0,0 @@
-import { ResponseBase } from "./responseBase";
-export type CallResponse = ResponseBase & {
-    task_id: number;
-};