@orchesty/connector-zendesk 1.0.0

package/src/Connector/ZendeskCreateUserConnector.ts

@@ -0,0 +1,60 @@
+import AConnector from '@orchesty/nodejs-sdk/dist/lib/Connector/AConnector';
+import { HttpMethods } from '@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods';
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+
+export const NAME = 'zendesk-create-user-connector';
+
+export default class ZendeskCreateUserConnector extends AConnector {
+
+    public getName(): string {
+        return NAME;
+    }
+
+    public async processAction(dto: ProcessDto<IInput>): Promise<ProcessDto<IOutput>> {
+        const body = dto.getJsonData();
+
+        const appInstall = await this.getApplicationInstallFromProcess(dto);
+        const req = await this.getApplication().getRequestDto(dto, appInstall, HttpMethods.POST, '/users.json', body);
+        const resp = await this.getSender().send<IResponse>(req, [201]);
+
+        const data = resp.getJsonBody();
+
+        return dto.setNewJsonData(data.user);
+    }
+
+}
+
+/* eslint-disable @typescript-eslint/naming-convention */
+export interface IResponse {
+    user: IOutput;
+}
+
+export interface IOutput {
+    custom_role_id: number;
+    email: string;
+    id: number;
+    name: string;
+    organization_id: number;
+    role: string;
+    role_type: number;
+}
+
+export interface IInput {
+    user: {
+        custom_role_id?: number;
+        identities?: [
+            {
+                type: string;
+                value: string;
+            },
+        ];
+        organization?: {
+            name: string;
+        };
+        role?: string;
+    };
+    name: string;
+    email: string;
+}
+
+/* eslint-enable @typescript-eslint/naming-convention */

package/src/Connector/ZendeskDeleteTriggerConnector.ts

@@ -0,0 +1,46 @@
+import AConnector from '@orchesty/nodejs-sdk/dist/lib/Connector/AConnector';
+import { HttpMethods } from '@orchesty/nodejs-sdk/dist/lib/Transport/HttpMethods';
+import ProcessDto from '@orchesty/nodejs-sdk/dist/lib/Utils/ProcessDto';
+
+export const ZENDESK_DELETE_TRIGGER = 'zendesk-delete-trigger-connector';
+
+export default class ZendeskDeleteTriggerConnector extends AConnector {
+
+    public getName(): string {
+        return ZENDESK_DELETE_TRIGGER;
+    }
+
+    public async processAction(
+        dto: ProcessDto<ZendeskDeleteTriggerInput>,
+    ): Promise<ProcessDto<ZendeskDeleteTriggerOutput>> {
+        const data = this.getData(dto);
+
+        const req = await this.getApplication().getRequestDto(
+            dto,
+            await this.getApplicationInstallFromProcess(dto),
+            HttpMethods.DELETE,
+            `triggers/${data.id}`,
+            {
+                trigger: data,
+            },
+        );
+        await this.getSender().send(req);
+
+        return this.setResponse(dto);
+    }
+
+    protected getData(dto: ProcessDto<ZendeskDeleteTriggerInput>): ZendeskDeleteTriggerInput {
+        return dto.getJsonData();
+    }
+
+    protected setResponse(dto: ProcessDto<ZendeskDeleteTriggerInput>): ProcessDto<ZendeskDeleteTriggerOutput> {
+        return dto;
+    }
+
+}
+
+export interface ZendeskDeleteTriggerInput {
+    id: string | number;
+}
+
+export type ZendeskDeleteTriggerOutput = ZendeskDeleteTriggerInput;

package/src/Connector/__tests__/Data/ZendeskCreateTicketConnector/input.json

@@ -0,0 +1,14 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "ticket": {
+            "comment": {
+                "body": "The smoke is very colorful."
+            },
+            "priority": "urgent",
+            "subject": "My printer is on fire!"
+        }
+    }
+}

package/src/Connector/__tests__/Data/ZendeskCreateTicketConnector/mock.json

@@ -0,0 +1,194 @@
+{
+    "http": "POST https://hbtest8393.zendesk.com/api/v2/tickets.json",
+    "code": 201,
+    "body": {
+        "ticket": {
+            "audit": {
+                "author_id": 6279089898141,
+                "created_at": "2022-08-16T11:14:59Z",
+                "events": [
+                    {
+                        "attachments": [],
+                        "audit_id": 6340579809949,
+                        "author_id": 6279089898141,
+                        "body": "The smoke is very colorful.",
+                        "html_body": "<div class=\"zd-comment\" dir=\"auto\"><p dir=\"auto\">The smoke is very colorful.</p></div>",
+                        "id": 6340579810077,
+                        "plain_body": "The smoke is very colorful.",
+                        "public": true,
+                        "type": "Comment"
+                    },
+                    {
+                        "field_name": "priority",
+                        "id": 6340579810205,
+                        "type": "Create",
+                        "value": "urgent"
+                    },
+                    {
+                        "field_name": "subject",
+                        "id": 6340579810333,
+                        "type": "Create",
+                        "value": "My printer is on fire!"
+                    },
+                    {
+                        "field_name": "requester_id",
+                        "id": 6340579810461,
+                        "type": "Create",
+                        "value": "6279089898141"
+                    },
+                    {
+                        "field_name": "type",
+                        "id": 6340579810589,
+                        "type": "Create",
+                        "value": null
+                    },
+                    {
+                        "field_name": "status",
+                        "id": 6340579810717,
+                        "type": "Create",
+                        "value": "open"
+                    },
+                    {
+                        "field_name": "assignee_id",
+                        "id": 6340579810845,
+                        "type": "Create",
+                        "value": "6279089898141"
+                    },
+                    {
+                        "field_name": "group_id",
+                        "id": 6340579810973,
+                        "type": "Create",
+                        "value": "6279167766941"
+                    },
+                    {
+                        "field_name": "organization_id",
+                        "id": 6340579811101,
+                        "type": "Create",
+                        "value": "6279167768093"
+                    },
+                    {
+                        "field_name": "brand_id",
+                        "id": 6340579811229,
+                        "type": "Create",
+                        "value": "6279120605853"
+                    },
+                    {
+                        "field_name": "ticket_form_id",
+                        "id": 6340579811357,
+                        "type": "Create",
+                        "value": "6279120591901"
+                    },
+                    {
+                        "body": "A ticket (#{{ticket.id}}) by {{ticket.requester.name}} has been received. It is unassigned.\n\n{{ticket.latest_comment_html}}",
+                        "id": 6340579811485,
+                        "recipients": [
+                            6279089898141
+                        ],
+                        "subject": "[{{ticket.account}}] {{ticket.title}}",
+                        "type": "Notification",
+                        "via": {
+                            "channel": "rule",
+                            "source": {
+                                "from": {
+                                    "deleted": false,
+                                    "id": 6279167804573,
+                                    "title": "Notify all agents of received request"
+                                },
+                                "rel": "trigger"
+                            }
+                        }
+                    },
+                    {
+                        "body": "This ticket was created on your behalf.\n\nTo add additional comments, reply to this email.\n\n{{ticket.latest_public_comment_html}}",
+                        "id": 6340579811613,
+                        "recipients": [
+                            6279089898141
+                        ],
+                        "subject": "{{ticket.title}}",
+                        "type": "Notification",
+                        "via": {
+                            "channel": "rule",
+                            "source": {
+                                "from": {
+                                    "deleted": false,
+                                    "id": 6279167793181,
+                                    "title": "Notify requester of new proactive ticket"
+                                },
+                                "rel": "trigger"
+                            }
+                        }
+                    }
+                ],
+                "id": 6340579809949,
+                "metadata": {
+                    "custom": {},
+                    "system": {
+                        "client": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+                        "ip_address": "188.122.212.69",
+                        "latitude": 50.1982,
+                        "location": "Hradec Králové, 52, Czechia",
+                        "longitude": 15.8825
+                    }
+                },
+                "ticket_id": 2,
+                "via": {
+                    "channel": "api",
+                    "source": {
+                        "from": {},
+                        "rel": null,
+                        "to": {
+                            "address": "test.hanaboso@gmail.com",
+                            "name": "Test Test"
+                        }
+                    }
+                }
+            },
+            "ticket": {
+                "allow_attachments": true,
+                "allow_channelback": false,
+                "assignee_id": 6279089898141,
+                "brand_id": 6279120605853,
+                "collaborator_ids": [],
+                "created_at": "2022-08-16T11:14:59Z",
+                "custom_fields": [],
+                "description": "The smoke is very colorful.",
+                "due_at": null,
+                "email_cc_ids": [],
+                "external_id": null,
+                "fields": [],
+                "follower_ids": [],
+                "followup_ids": [],
+                "forum_topic_id": null,
+                "group_id": 6279167766941,
+                "has_incidents": false,
+                "id": 2,
+                "is_public": true,
+                "organization_id": 6279167768093,
+                "priority": "urgent",
+                "problem_id": null,
+                "raw_subject": "My printer is on fire!",
+                "recipient": null,
+                "requester_id": 6279089898141,
+                "satisfaction_rating": null,
+                "sharing_agreement_ids": [],
+                "status": "open",
+                "subject": "My printer is on fire!",
+                "submitter_id": 6279089898141,
+                "tags": [],
+                "ticket_form_id": 6279120591901,
+                "type": null,
+                "updated_at": "2022-08-16T11:14:59Z",
+                "url": "https://hbtest8393.zendesk.com/api/v2/tickets/2.json",
+                "via": {
+                    "channel": "api",
+                    "source": {
+                        "from": {},
+                        "rel": null,
+                        "to": {}
+                    }
+                }
+            }
+        }
+    }
+}
+

package/src/Connector/__tests__/Data/ZendeskCreateTicketConnector/output.json

@@ -0,0 +1,194 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "ticket": {
+            "audit": {
+                "author_id": 6279089898141,
+                "created_at": "2022-08-16T11:14:59Z",
+                "events": [
+                    {
+                        "attachments": [],
+                        "audit_id": 6340579809949,
+                        "author_id": 6279089898141,
+                        "body": "The smoke is very colorful.",
+                        "html_body": "<div class=\"zd-comment\" dir=\"auto\"><p dir=\"auto\">The smoke is very colorful.</p></div>",
+                        "id": 6340579810077,
+                        "plain_body": "The smoke is very colorful.",
+                        "public": true,
+                        "type": "Comment"
+                    },
+                    {
+                        "field_name": "priority",
+                        "id": 6340579810205,
+                        "type": "Create",
+                        "value": "urgent"
+                    },
+                    {
+                        "field_name": "subject",
+                        "id": 6340579810333,
+                        "type": "Create",
+                        "value": "My printer is on fire!"
+                    },
+                    {
+                        "field_name": "requester_id",
+                        "id": 6340579810461,
+                        "type": "Create",
+                        "value": "6279089898141"
+                    },
+                    {
+                        "field_name": "type",
+                        "id": 6340579810589,
+                        "type": "Create",
+                        "value": null
+                    },
+                    {
+                        "field_name": "status",
+                        "id": 6340579810717,
+                        "type": "Create",
+                        "value": "open"
+                    },
+                    {
+                        "field_name": "assignee_id",
+                        "id": 6340579810845,
+                        "type": "Create",
+                        "value": "6279089898141"
+                    },
+                    {
+                        "field_name": "group_id",
+                        "id": 6340579810973,
+                        "type": "Create",
+                        "value": "6279167766941"
+                    },
+                    {
+                        "field_name": "organization_id",
+                        "id": 6340579811101,
+                        "type": "Create",
+                        "value": "6279167768093"
+                    },
+                    {
+                        "field_name": "brand_id",
+                        "id": 6340579811229,
+                        "type": "Create",
+                        "value": "6279120605853"
+                    },
+                    {
+                        "field_name": "ticket_form_id",
+                        "id": 6340579811357,
+                        "type": "Create",
+                        "value": "6279120591901"
+                    },
+                    {
+                        "body": "A ticket (#{{ticket.id}}) by {{ticket.requester.name}} has been received. It is unassigned.\n\n{{ticket.latest_comment_html}}",
+                        "id": 6340579811485,
+                        "recipients": [
+                            6279089898141
+                        ],
+                        "subject": "[{{ticket.account}}] {{ticket.title}}",
+                        "type": "Notification",
+                        "via": {
+                            "channel": "rule",
+                            "source": {
+                                "from": {
+                                    "deleted": false,
+                                    "id": 6279167804573,
+                                    "title": "Notify all agents of received request"
+                                },
+                                "rel": "trigger"
+                            }
+                        }
+                    },
+                    {
+                        "body": "This ticket was created on your behalf.\n\nTo add additional comments, reply to this email.\n\n{{ticket.latest_public_comment_html}}",
+                        "id": 6340579811613,
+                        "recipients": [
+                            6279089898141
+                        ],
+                        "subject": "{{ticket.title}}",
+                        "type": "Notification",
+                        "via": {
+                            "channel": "rule",
+                            "source": {
+                                "from": {
+                                    "deleted": false,
+                                    "id": 6279167793181,
+                                    "title": "Notify requester of new proactive ticket"
+                                },
+                                "rel": "trigger"
+                            }
+                        }
+                    }
+                ],
+                "id": 6340579809949,
+                "metadata": {
+                    "custom": {},
+                    "system": {
+                        "client": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+                        "ip_address": "188.122.212.69",
+                        "latitude": 50.1982,
+                        "location": "Hradec Králové, 52, Czechia",
+                        "longitude": 15.8825
+                    }
+                },
+                "ticket_id": 2,
+                "via": {
+                    "channel": "api",
+                    "source": {
+                        "from": {},
+                        "rel": null,
+                        "to": {
+                            "address": "test.hanaboso@gmail.com",
+                            "name": "Test Test"
+                        }
+                    }
+                }
+            },
+            "ticket": {
+                "allow_attachments": true,
+                "allow_channelback": false,
+                "assignee_id": 6279089898141,
+                "brand_id": 6279120605853,
+                "collaborator_ids": [],
+                "created_at": "2022-08-16T11:14:59Z",
+                "custom_fields": [],
+                "description": "The smoke is very colorful.",
+                "due_at": null,
+                "email_cc_ids": [],
+                "external_id": null,
+                "fields": [],
+                "follower_ids": [],
+                "followup_ids": [],
+                "forum_topic_id": null,
+                "group_id": 6279167766941,
+                "has_incidents": false,
+                "id": 2,
+                "is_public": true,
+                "organization_id": 6279167768093,
+                "priority": "urgent",
+                "problem_id": null,
+                "raw_subject": "My printer is on fire!",
+                "recipient": null,
+                "requester_id": 6279089898141,
+                "satisfaction_rating": null,
+                "sharing_agreement_ids": [],
+                "status": "open",
+                "subject": "My printer is on fire!",
+                "submitter_id": 6279089898141,
+                "tags": [],
+                "ticket_form_id": 6279120591901,
+                "type": null,
+                "updated_at": "2022-08-16T11:14:59Z",
+                "url": "https://hbtest8393.zendesk.com/api/v2/tickets/2.json",
+                "via": {
+                    "channel": "api",
+                    "source": {
+                        "from": {},
+                        "rel": null,
+                        "to": {}
+                    }
+                }
+            }
+        }
+    }
+}

package/src/Connector/__tests__/Data/ZendeskCreateTriggerConnector/input.json

@@ -0,0 +1,11 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "actions": [],
+        "conditions": {},
+        "title": "title",
+        "category_id": "category_id"
+    }
+}

package/src/Connector/__tests__/Data/ZendeskCreateTriggerConnector/mock.json

@@ -0,0 +1,31 @@
+{
+  "http": "POST https://hbtest8393.zendesk.com/api/v2/triggers",
+  "code": 201,
+  "body": {
+    "trigger": {
+      "actions": [
+        {
+          "field": "group_id",
+          "value": "20455932"
+        }
+      ],
+      "category_id": "10026",
+      "conditions": {
+        "all": [
+          {
+            "field": "status",
+            "operator": "is",
+            "value": "open"
+          },
+          {
+            "field": "priority",
+            "operator": "less_than",
+            "value": "high"
+          }
+        ]
+      },
+      "title": "Roger Wilco"
+    }
+  }
+}
+

package/src/Connector/__tests__/Data/ZendeskCreateTriggerConnector/output.json

@@ -0,0 +1,29 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "actions": [
+            {
+                "field": "group_id",
+                "value": "20455932"
+            }
+        ],
+        "category_id": "10026",
+        "conditions": {
+            "all": [
+                {
+                    "field": "status",
+                    "operator": "is",
+                    "value": "open"
+                },
+                {
+                    "field": "priority",
+                    "operator": "less_than",
+                    "value": "high"
+                }
+            ]
+        },
+        "title": "Roger Wilco"
+    }
+}

package/src/Connector/__tests__/Data/ZendeskCreateUserConnector/input.json

@@ -0,0 +1,25 @@
+{
+    "headers": {
+        "user": "TestUser"
+    },
+    "data": {
+        "user": {
+            "email": "robert@example.org",
+            "identities": [
+                {
+                    "type": "email",
+                    "value": "test1@user.com"
+                },
+                {
+                    "type": "twitter",
+                    "value": "tester841"
+                }
+            ],
+            "name": "robert Wilco",
+            "organization": {
+                "name": "VIP Customers"
+            },
+            "role": "admin"
+        }
+    }
+}

package/src/Connector/__tests__/Data/ZendeskCreateUserConnector/mock.json

@@ -0,0 +1,45 @@
+{
+    "http": "POST https://hbtest8393.zendesk.com/api/v2/users.json",
+    "code": 201,
+    "body": {
+        "user": {
+            "active": true,
+            "alias": null,
+            "created_at": "2022-08-16T12:42:32Z",
+            "custom_role_id": 6279152989725,
+            "default_group_id": 6279167766941,
+            "details": null,
+            "email": "test1@user.com",
+            "external_id": null,
+            "iana_time_zone": "Europe/Prague",
+            "id": 6342061201949,
+            "last_login_at": null,
+            "locale": "en-US",
+            "locale_id": 1,
+            "moderator": true,
+            "name": "robert Wilco",
+            "notes": null,
+            "only_private_comments": false,
+            "organization_id": null,
+            "phone": null,
+            "photo": null,
+            "report_csv": false,
+            "restricted_agent": false,
+            "role": "admin",
+            "role_type": 4,
+            "shared": false,
+            "shared_agent": false,
+            "shared_phone_number": null,
+            "signature": null,
+            "suspended": false,
+            "tags": [],
+            "ticket_restriction": null,
+            "time_zone": "Europe/Prague",
+            "two_factor_auth_enabled": null,
+            "updated_at": "2022-08-16T12:42:32Z",
+            "url": "https://hbtest8393.zendesk.com/api/v2/users/6342061201949.json",
+            "user_fields": {},
+            "verified": false
+        }
+    }
+}