@orchesty/connector-zendesk 1.0.0

package/coverage/lcov.info

@@ -0,0 +1,389 @@
+TN:
+SF:src/ZendeskApplication.ts
+FN:21,(anonymous_10)
+FN:25,(anonymous_11)
+FN:29,(anonymous_12)
+FN:33,(anonymous_13)
+FN:37,(anonymous_14)
+FN:62,(anonymous_15)
+FN:66,(anonymous_16)
+FN:75,(anonymous_17)
+FN:83,(anonymous_18)
+FN:87,(anonymous_19)
+FN:91,(anonymous_20)
+FN:95,(anonymous_21)
+FN:99,(anonymous_22)
+FN:113,(anonymous_23)
+FN:117,(anonymous_24)
+FNF:15
+FNH:2
+FNDA:0,(anonymous_10)
+FNDA:11,(anonymous_11)
+FNDA:0,(anonymous_12)
+FNDA:0,(anonymous_13)
+FNDA:6,(anonymous_14)
+FNDA:0,(anonymous_15)
+FNDA:0,(anonymous_16)
+FNDA:0,(anonymous_17)
+FNDA:0,(anonymous_18)
+FNDA:0,(anonymous_19)
+FNDA:0,(anonymous_20)
+FNDA:0,(anonymous_21)
+FNDA:0,(anonymous_22)
+FNDA:0,(anonymous_23)
+FNDA:0,(anonymous_24)
+DA:1,5
+DA:3,5
+DA:4,5
+DA:5,5
+DA:6,5
+DA:8,5
+DA:9,5
+DA:10,5
+DA:11,5
+DA:12,5
+DA:15,5
+DA:17,5
+DA:18,5
+DA:19,5
+DA:22,0
+DA:26,11
+DA:30,0
+DA:34,0
+DA:44,6
+DA:45,6
+DA:47,6
+DA:48,6
+DA:54,6
+DA:55,3
+DA:58,6
+DA:63,0
+DA:67,0
+DA:72,0
+DA:76,0
+DA:77,0
+DA:84,0
+DA:88,0
+DA:92,0
+DA:96,0
+DA:100,0
+DA:105,0
+DA:106,0
+DA:107,0
+DA:110,0
+DA:114,0
+DA:118,0
+LF:41
+LH:22
+BRDA:54,0,0,3
+BRDA:54,0,1,3
+BRDA:77,1,0,0
+BRDA:77,1,1,0
+BRDA:77,1,2,0
+BRDA:77,1,3,0
+BRDA:106,2,0,0
+BRDA:106,2,1,0
+BRF:8
+BRH:2
+end_of_record
+TN:
+SF:src/Batch/ZendeskCreateWebhookConnector.ts
+FN:19,(anonymous_1)
+FN:23,(anonymous_2)
+FN:32,(anonymous_3)
+FN:41,(anonymous_4)
+FN:41,(anonymous_5)
+FN:77,(anonymous_6)
+FN:81,(anonymous_7)
+FNF:7
+FNH:1
+FNDA:5,(anonymous_1)
+FNDA:0,(anonymous_2)
+FNDA:0,(anonymous_3)
+FNDA:0,(anonymous_4)
+FNDA:0,(anonymous_5)
+FNDA:0,(anonymous_6)
+FNDA:0,(anonymous_7)
+DA:1,5
+DA:3,5
+DA:4,5
+DA:5,5
+DA:8,5
+DA:12,5
+DA:17,5
+DA:20,5
+DA:26,0
+DA:28,0
+DA:29,0
+DA:31,0
+DA:32,0
+DA:41,0
+DA:43,0
+DA:44,0
+DA:59,0
+DA:60,0
+DA:62,0
+DA:74,0
+DA:78,0
+DA:82,0
+LF:22
+LH:8
+BRDA:38,0,0,0
+BRDA:38,0,1,0
+BRF:2
+BRH:0
+end_of_record
+TN:
+SF:src/Batch/ZendeskDeleteWebhookConnector.ts
+FN:13,(anonymous_1)
+FN:17,(anonymous_2)
+FNF:2
+FNH:1
+FNDA:5,(anonymous_1)
+FNDA:0,(anonymous_2)
+DA:1,5
+DA:3,5
+DA:4,5
+DA:5,5
+DA:7,5
+DA:9,5
+DA:11,5
+DA:14,5
+DA:18,0
+DA:19,0
+DA:20,0
+DA:21,0
+DA:23,0
+DA:24,0
+DA:25,0
+DA:26,0
+DA:27,0
+DA:28,0
+DA:29,0
+DA:30,0
+DA:32,0
+DA:33,0
+DA:36,0
+LF:23
+LH:8
+BRDA:23,0,0,0
+BRDA:23,0,1,0
+BRDA:27,1,0,0
+BRDA:27,1,1,0
+BRDA:27,2,0,0
+BRDA:27,2,1,0
+BRF:6
+BRH:0
+end_of_record
+TN:
+SF:src/Batch/ZendeskListTicketsBatch.ts
+FN:9,(anonymous_1)
+FN:13,(anonymous_2)
+FNF:2
+FNH:2
+FNDA:5,(anonymous_1)
+FNDA:2,(anonymous_2)
+DA:1,5
+DA:2,5
+DA:5,5
+DA:7,5
+DA:10,5
+DA:14,2
+DA:15,2
+DA:16,2
+DA:22,2
+DA:23,2
+DA:25,2
+DA:26,2
+DA:27,1
+DA:30,2
+LF:14
+LH:14
+BRDA:25,0,0,2
+BRDA:25,0,1,0
+BRDA:26,1,0,1
+BRDA:26,1,1,1
+BRF:4
+BRH:3
+end_of_record
+TN:
+SF:src/Batch/ZendeskListUsersBatch.ts
+FN:10,(anonymous_1)
+FN:14,(anonymous_2)
+FNF:2
+FNH:2
+FNDA:5,(anonymous_1)
+FNDA:1,(anonymous_2)
+DA:1,5
+DA:2,5
+DA:6,5
+DA:8,5
+DA:11,5
+DA:15,1
+DA:16,1
+DA:17,1
+DA:23,1
+DA:24,1
+DA:26,1
+DA:27,1
+DA:28,0
+DA:31,1
+LF:14
+LH:13
+BRDA:26,0,0,1
+BRDA:26,0,1,0
+BRDA:27,1,0,0
+BRDA:27,1,1,1
+BRF:4
+BRH:2
+end_of_record
+TN:
+SF:src/Connector/ZendeskCreateTicketConnector.ts
+FN:9,(anonymous_1)
+FN:13,(anonymous_2)
+FNF:2
+FNH:2
+FNDA:5,(anonymous_1)
+FNDA:1,(anonymous_2)
+DA:1,5
+DA:2,5
+DA:5,5
+DA:7,5
+DA:10,5
+DA:14,1
+DA:16,1
+DA:17,1
+DA:18,1
+DA:20,1
+LF:10
+LH:10
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:src/Connector/ZendeskCreateTriggerConnector.ts
+FN:10,(anonymous_1)
+FN:14,(anonymous_2)
+FN:31,(anonymous_3)
+FN:35,(anonymous_4)
+FNF:4
+FNH:4
+FNDA:5,(anonymous_1)
+FNDA:1,(anonymous_2)
+FNDA:1,(anonymous_3)
+FNDA:1,(anonymous_4)
+DA:1,5
+DA:2,5
+DA:6,5
+DA:8,5
+DA:11,5
+DA:17,1
+DA:19,1
+DA:26,1
+DA:28,1
+DA:32,1
+DA:36,1
+LF:11
+LH:11
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:src/Connector/ZendeskCreateUserConnector.ts
+FN:9,(anonymous_1)
+FN:13,(anonymous_2)
+FNF:2
+FNH:2
+FNDA:5,(anonymous_1)
+FNDA:1,(anonymous_2)
+DA:1,5
+DA:2,5
+DA:5,5
+DA:7,5
+DA:10,5
+DA:14,1
+DA:16,1
+DA:17,1
+DA:18,1
+DA:20,1
+DA:22,1
+LF:11
+LH:11
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:src/Connector/ZendeskDeleteTriggerConnector.ts
+FN:9,(anonymous_1)
+FN:13,(anonymous_2)
+FN:32,(anonymous_3)
+FN:36,(anonymous_4)
+FNF:4
+FNH:1
+FNDA:5,(anonymous_1)
+FNDA:0,(anonymous_2)
+FNDA:0,(anonymous_3)
+FNDA:0,(anonymous_4)
+DA:1,5
+DA:2,5
+DA:5,5
+DA:7,5
+DA:10,5
+DA:16,0
+DA:18,0
+DA:27,0
+DA:29,0
+DA:33,0
+DA:37,0
+LF:11
+LH:5
+BRF:0
+BRH:0
+end_of_record
+TN:
+SF:test/dataProvider.ts
+FN:17,init
+FNF:1
+FNH:1
+FNDA:5,init
+DA:1,5
+DA:2,5
+DA:3,5
+DA:4,5
+DA:5,5
+DA:6,5
+DA:7,5
+DA:8,5
+DA:9,5
+DA:10,5
+DA:11,5
+DA:12,5
+DA:13,5
+DA:14,5
+DA:15,5
+DA:17,5
+DA:18,5
+DA:28,5
+DA:38,5
+DA:39,5
+DA:41,5
+DA:42,5
+DA:43,5
+DA:44,5
+DA:46,5
+DA:50,5
+DA:52,5
+DA:56,5
+DA:58,5
+DA:62,5
+DA:64,5
+DA:68,5
+DA:70,5
+DA:71,5
+DA:72,5
+DA:73,5
+LF:36
+LH:36
+BRF:0
+BRH:0
+end_of_record

package/dist/Batch/ZendeskCreateWebhookConnector.d.ts

@@ -0,0 +1,16 @@
+import ABatchNode from '@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode';
+import BatchProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/BatchProcessDto';
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+export declare const ZENDESK_CREATE_WEBHOOK = "zendesk-create-webhook";
+export default class ZendeskCreateWebhookConnector extends ABatchNode {
+    getName(): string;
+    processAction(dto: BatchProcessDto<ZendeskCreateWebhookInput>): Promise<BatchProcessDto>;
+    protected getData(dto: ProcessDto<ZendeskCreateWebhookInput>): ZendeskCreateWebhookInput;
+    protected getRandomToken(): string;
+}
+export interface ZendeskCreateWebhookInput {
+    topology: string;
+    node: string;
+    name: string;
+    events: string[];
+}

package/dist/Batch/ZendeskCreateWebhookConnector.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZENDESK_CREATE_WEBHOOK = void 0;
+const Webhook_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Application/Database/Webhook"));
+const ABatchNode_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode"));
+const TopologyRunner_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Topology/TopologyRunner"));
+const HttpMethods_1 = require("@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods");
+const crypto_1 = __importDefault(require("crypto"));
+exports.ZENDESK_CREATE_WEBHOOK = 'zendesk-create-webhook';
+class ZendeskCreateWebhookConnector extends ABatchNode_1.default {
+    getName() {
+        return exports.ZENDESK_CREATE_WEBHOOK;
+    }
+    async processAction(dto) {
+        const repo = this.getDbClient().getRepository(Webhook_1.default);
+        const app = this.getApplication();
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const registered = await repo.findMany({ users: [appInstall.getUser()], apps: [appInstall.getName()] });
+        const all = app.getWebhookSubscriptions().map((sub) => ({
+            event: sub.getName(),
+            token: this.getRandomToken(),
+            node: sub.getNode(),
+            name: sub.getName(),
+            topology: sub.getTopology(),
+            events: JSON.parse(sub.getParameters().events || '[]'),
+        }));
+        const unregistered = all.filter((wh) => !registered.find((reg) => reg.getName() === wh.event));
+        for (const toRegister of unregistered) {
+            const reqBody = {
+                webhook: {
+                    endpoint: TopologyRunner_1.default.getWebhookUrl(toRegister.topology, toRegister.node, toRegister.token),
+                    http_method: 'POST',
+                    name: toRegister.name,
+                    request_format: 'json',
+                    status: 'active',
+                    subscriptions: toRegister.events,
+                },
+            };
+            const requestDto = await app.getRequestDto(dto, appInstall, HttpMethods_1.HttpMethods.POST, '/webhooks', reqBody);
+            const data = (await this.getSender().send(requestDto)).getJsonBody();
+            await repo.insert(new Webhook_1.default()
+                .setWebhookId(data.webhook.id)
+                .setUser(appInstall.getUser())
+                .setNode(toRegister.node)
+                .setToken(toRegister.token)
+                .setApplication(app.getName())
+                .setTopology(toRegister.topology)
+                .setName(data.webhook.name));
+        }
+        return dto;
+    }
+    getData(dto) {
+        return dto.getJsonData();
+    }
+    getRandomToken() {
+        return crypto_1.default.randomBytes(64).toString('hex');
+    }
+}
+exports.default = ZendeskCreateWebhookConnector;

package/dist/Batch/ZendeskDeleteWebhookConnector.d.ts

@@ -0,0 +1,7 @@
+import ABatchNode from '@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode';
+import BatchProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/BatchProcessDto';
+export declare const ZENDESK_DELETE_WEBHOOK = "zendesk-delete-webhook";
+export default class ZendeskDeleteWebhookConnector extends ABatchNode {
+    getName(): string;
+    processAction(dto: BatchProcessDto): Promise<BatchProcessDto>;
+}

package/dist/Batch/ZendeskDeleteWebhookConnector.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZENDESK_DELETE_WEBHOOK = void 0;
+const Webhook_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Application/Database/Webhook"));
+const ABatchNode_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode"));
+const OnRepeatException_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Exception/OnRepeatException"));
+const HttpMethods_1 = require("@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods");
+const http_status_codes_1 = require("http-status-codes");
+exports.ZENDESK_DELETE_WEBHOOK = 'zendesk-delete-webhook';
+class ZendeskDeleteWebhookConnector extends ABatchNode_1.default {
+    getName() {
+        return exports.ZENDESK_DELETE_WEBHOOK;
+    }
+    async processAction(dto) {
+        const app = this.getApplication();
+        const appInstall = await this.getApplicationInstallFromProcess(dto, null);
+        const repo = this.getDbClient().getRepository(Webhook_1.default);
+        const webhook = await repo.findOne({ users: [appInstall.getUser()], apps: [appInstall.getName()] });
+        if (webhook) {
+            const url = `/webhooks/${webhook.getWebhookId()}`;
+            const requestDto = await app.getRequestDto(dto, appInstall, HttpMethods_1.HttpMethods.DELETE, url);
+            const res = await this.getSender().send(requestDto);
+            if (res.getResponseCode() !== http_status_codes_1.StatusCodes.OK && res.getResponseCode() !== http_status_codes_1.StatusCodes.NOT_FOUND) {
+                webhook.setUnsubscribeFailed(true);
+                await repo.update(webhook);
+                throw new OnRepeatException_1.default(300, 12, res.getBody());
+            }
+            await repo.remove(webhook);
+            dto.setBatchCursor('1', true);
+        }
+        return dto;
+    }
+}
+exports.default = ZendeskDeleteWebhookConnector;

package/dist/Batch/ZendeskListTicketsBatch.d.ts

@@ -0,0 +1,46 @@
+import ABatchNode from '@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode';
+import BatchProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/BatchProcessDto';
+export declare const NAME = "zendesk-list-tickets-batch";
+export default class ZendeskListTicketsBatch extends ABatchNode {
+    getName(): string;
+    processAction(dto: BatchProcessDto): Promise<BatchProcessDto>;
+}
+export interface IOutput {
+    assignee_id: number;
+    collaborator_ids: number[];
+    created_at: string;
+    custom_fields: [
+        {
+            id: number;
+            value: string;
+        }
+    ];
+    description: string;
+    external_id: string;
+    follower_ids: number[];
+    group_id: number;
+    has_incidents: boolean;
+    id: number;
+    organization_id: number;
+    priority: string;
+    problem_id: number;
+    raw_subject: string;
+    recipient: string;
+    requester_id: number;
+    satisfaction_rating: {
+        comment: string;
+        id: number;
+        score: string;
+    };
+    sharing_agreement_ids: number[];
+    status: string;
+    subject: string;
+    submitter_id: number;
+    tags: string[];
+    type: string;
+    updated_at: string;
+    url: string;
+    via: {
+        channel: string;
+    };
+}

package/dist/Batch/ZendeskListTicketsBatch.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NAME = void 0;
+const ABatchNode_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode"));
+const HttpMethods_1 = require("@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods");
+exports.NAME = 'zendesk-list-tickets-batch';
+class ZendeskListTicketsBatch extends ABatchNode_1.default {
+    getName() {
+        return exports.NAME;
+    }
+    async processAction(dto) {
+        const offset = dto.getBatchCursor('1');
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const req = await this.getApplication().getRequestDto(dto, appInstall, HttpMethods_1.HttpMethods.GET, `/tickets.json?per_page=100&page=${offset}`);
+        const resp = await this.getSender().send(req, [200]);
+        const response = resp.getJsonBody();
+        dto.setItemList(response.tickets ?? []);
+        if (response.next_page !== null) {
+            dto.setBatchCursor((Number(offset) + 1).toString());
+        }
+        return dto;
+    }
+}
+exports.default = ZendeskListTicketsBatch;

package/dist/Batch/ZendeskListUsersBatch.d.ts

@@ -0,0 +1,11 @@
+import ABatchNode from '@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode';
+import BatchProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/BatchProcessDto';
+export declare const NAME = "zendesk-list-users-batch";
+export default class ZendeskListUsersBatch extends ABatchNode {
+    getName(): string;
+    processAction(dto: BatchProcessDto): Promise<BatchProcessDto>;
+}
+export interface IOutput {
+    id: number;
+    name: string;
+}

package/dist/Batch/ZendeskListUsersBatch.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NAME = void 0;
+const ABatchNode_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Batch/ABatchNode"));
+const HttpMethods_1 = require("@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods");
+exports.NAME = 'zendesk-list-users-batch';
+class ZendeskListUsersBatch extends ABatchNode_1.default {
+    getName() {
+        return exports.NAME;
+    }
+    async processAction(dto) {
+        const offset = dto.getBatchCursor('1');
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const req = await this.getApplication().getRequestDto(dto, appInstall, HttpMethods_1.HttpMethods.GET, `/users.json?per_page=100&page=${offset}`);
+        const resp = await this.getSender().send(req, [200]);
+        const response = resp.getJsonBody();
+        dto.setItemList(response.users ?? []);
+        if (response.meta.has_more) {
+            dto.setBatchCursor((Number(offset) + 1).toString());
+        }
+        return dto;
+    }
+}
+exports.default = ZendeskListUsersBatch;

package/dist/Connector/ZendeskCreateTicketConnector.d.ts

@@ -0,0 +1,57 @@
+import AConnector from '@orchesty/nodejs-sdk/dist/lib/Connector/AConnector';
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+export declare const NAME = "zendesk-create-ticket-connector";
+export default class ZendeskCreateTicketConnector extends AConnector {
+    getName(): string;
+    processAction(dto: ProcessDto<IInput>): Promise<ProcessDto<IOutput>>;
+}
+export interface IInput {
+    ticket: {
+        comment: {
+            body: string;
+        };
+        priority: string;
+        subject: string;
+    };
+}
+export interface IOutput {
+    ticket: {
+        assignee_id: number;
+        collaborator_ids: number[];
+        created_at: string;
+        custom_fields: [
+            {
+                id: number;
+                value: string;
+            }
+        ];
+        description: string;
+        external_id: string;
+        follower_ids: number[];
+        group_id: number;
+        has_incidents: boolean;
+        id: number;
+        organization_id: number;
+        priority: string;
+        problem_id: number;
+        raw_subject: string;
+        recipient: string;
+        requester_id: number;
+        satisfaction_rating: {
+            comment: string;
+            id: number;
+            score: string;
+        };
+        sharing_agreement_ids: number[];
+        status: string;
+        subject: string;
+        submitter_id: number;
+        tags: string[];
+        type: string;
+        updated_at: string;
+        url: string;
+        via: {
+            channel: string;
+        };
+    };
+}

package/dist/Connector/ZendeskCreateTicketConnector.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NAME = void 0;
+const AConnector_1 = __importDefault(require("@orchesty/nodejs-sdk/dist/lib/Connector/AConnector"));
+const HttpMethods_1 = require("@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods");
+exports.NAME = 'zendesk-create-ticket-connector';
+class ZendeskCreateTicketConnector extends AConnector_1.default {
+    getName() {
+        return exports.NAME;
+    }
+    async processAction(dto) {
+        const body = dto.getJsonData();
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const req = await this.getApplication().getRequestDto(dto, appInstall, HttpMethods_1.HttpMethods.POST, '/tickets.json', body);
+        const resp = await this.getSender().send(req, [201]);
+        return dto.setNewJsonData(resp.getJsonBody());
+    }
+}
+exports.default = ZendeskCreateTicketConnector;