@theholocron/zendesk-client 0.0.0

package/dist/index.mjs

@@ -0,0 +1,593 @@
+import appConf from "@ce/app-config";
+import { exreq, parseArgs, setBaseURL } from "@ce/utils-fetch";
+import axios from "axios";
+//#region src/activities/activities.ts
+const operation$5 = "/api/v2/activities";
+const getActivities = (options) => exreq({
+	operation: operation$5,
+	options: {
+		...options,
+		headers: {
+			...options.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+var activities_default$1 = { get: getActivities };
+//#endregion
+//#region src/attachments/attachments.mocks.ts
+const mockImage = {
+	content_type: "image/gif",
+	content_url: "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
+	deleted: false,
+	file_name: "1f84950b8d7949b3.gif",
+	height: 80,
+	id: 8730791,
+	inline: false,
+	mapped_content_url: "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
+	size: 4566,
+	url: "https://example.zendesk.com/api/v2/attachments/8730791.json",
+	width: 80
+};
+const mockThumbnail = {
+	content_type: "image/gif",
+	content_url: "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
+	deleted: false,
+	file_name: "1f84950b8d7949b3_thumb.gif",
+	height: 32,
+	id: 8730801,
+	inline: false,
+	mapped_content_url: "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
+	size: 1517,
+	url: "https://example.zendesk.com/api/v2/attachments/8730801.json",
+	width: 32
+};
+const mockAttachment = {
+	...mockImage,
+	thumbnails: [mockThumbnail]
+};
+//#endregion
+//#region src/user/user.mocks.ts
+const mockUser = {
+	active: true,
+	alias: "test",
+	created_at: "2017-08-14T20:13:53Z",
+	custom_role_id: null,
+	default_group_id: 1873,
+	details: "",
+	email: "user@zendesk.com",
+	external_id: "oev7jj",
+	iana_time_zone: "Pacific/Pago_Pago",
+	id: 3343,
+	last_login_at: "2020-11-16T22:57:45Z",
+	locale: "en-gb",
+	locale_id: 5,
+	moderator: true,
+	name: "Samwise Gamgee",
+	notes: "test",
+	only_private_comments: false,
+	organization_id: 1873,
+	phone: null,
+	photo: mockAttachment,
+	report_csv: true,
+	restricted_agent: false,
+	role: "admin",
+	role_type: null,
+	shared: false,
+	shared_agent: false,
+	shared_phone_number: null,
+	signature: "test",
+	suspended: false,
+	tags: ["101"],
+	ticket_restriction: null,
+	time_zone: "American Samoa",
+	two_factor_auth_enabled: null,
+	updated_at: "2020-11-17T00:33:55Z",
+	url: "https://example.zendesk.com/api/v2/users/3343.json",
+	user_fields: {
+		its_remember_september: null,
+		skittles: "2018-09-14T00:00:00+00:00",
+		user_field_1: "101"
+	},
+	verified: true
+};
+//#endregion
+//#region src/activities/activities.mocks.ts
+const mockActivity = {
+	actor: mockUser,
+	actor_id: 158488612,
+	created_at: "2020-11-17T00:34:40Z",
+	id: 29183462,
+	object: { ticket: {
+		id: 1521,
+		subject: "test"
+	} },
+	target: { ticket: {
+		id: 1521,
+		subject: "test"
+	} },
+	title: "Tedd assigned ticket #1521 to you.",
+	updated_at: "2020-11-17T00:34:40Z",
+	url: "https://example.zendesk.com/api/v2/activities/29183462.json",
+	user: mockUser,
+	user_id: 3343,
+	verb: "tickets.assignment"
+};
+const mockActivityResponse = {
+	activities: [mockActivity],
+	actors: [mockUser],
+	count: 1,
+	next_page: null,
+	previous_page: null,
+	users: [mockUser]
+};
+//#endregion
+//#region src/activities/index.ts
+var activities_default = { ...activities_default$1 };
+//#endregion
+//#region src/group/group.mocks.ts
+const mockGroup = {
+	created_at: "2018-04-06T03:17:05Z",
+	default: false,
+	deleted: false,
+	description: "",
+	id: 1835972,
+	name: "Ragtail",
+	updated_at: "2018-04-06T03:17:05Z",
+	url: "https://example.zendesk.com/api/v2/groups/1835972.json"
+};
+//#endregion
+//#region src/search/search.ts
+const operation$4 = "/api/v2/search";
+var search_default$1 = (query, options) => exreq({
+	operation: operation$4,
+	options: {
+		...options,
+		params: {
+			...options.params,
+			query,
+			sort_order: options?.sort || "desc"
+		},
+		headers: {
+			...options.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+//#endregion
+//#region src/tickets/fields.mocks.ts
+const mockCustomField1 = {
+	id: 27642,
+	value: "745"
+};
+const mockCustomField2 = {
+	id: 27648,
+	value: "yes"
+};
+const mockCustomFields = [mockCustomField1, mockCustomField2];
+const mockTicketField = {
+	active: true,
+	agent_description: "Agent only description",
+	collapsed_for_agents: false,
+	created_at: "2009-07-20T22:55:29Z",
+	description: "This is the subject field of a ticket",
+	editable_in_portal: true,
+	id: 34,
+	position: 21,
+	raw_description: "This is the subject field of a ticket",
+	raw_title: "{{dc.my_title}}",
+	raw_title_in_portal: "{{dc.my_title_in_portal}}",
+	regexp_for_validation: null,
+	required: true,
+	required_in_portal: true,
+	tag: null,
+	title: "Subject",
+	title_in_portal: "Subject",
+	type: "subject",
+	updated_at: "2011-05-05T10:38:52Z",
+	url: "https://company.zendesk.com/api/v2/ticket_fields/34.json",
+	visible_in_portal: true
+};
+const mockTicketFieldsResponse = {
+	count: 1,
+	ticket_fields: [mockTicketField]
+};
+const mockTicketFieldResponse = {
+	count: 1,
+	ticket_field: mockTicketField
+};
+//#endregion
+//#region src/tickets/tickets.mocks.ts
+const mockVia = {
+	channel: "web",
+	source: {
+		from: {},
+		rel: "web_widget",
+		to: {}
+	}
+};
+const mockMetadata = {
+	system: {
+		client: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36",
+		ip_address: "1.1.1.1",
+		latitude: -37.000000000001,
+		location: "Melbourne, 07, Australia",
+		longitude: 144.0000000000002
+	},
+	via: mockVia
+};
+const mockTicket = {
+	assignee_id: 235323,
+	collaborator_ids: [35334, 234],
+	created_at: "2009-07-20T22:55:29Z",
+	custom_fields: mockCustomFields,
+	custom_status_id: 123,
+	description: "The fire is very colorful.",
+	due_at: null,
+	external_id: "ahg35h3jh",
+	follower_ids: [35334, 234],
+	from_messaging_channel: false,
+	group_id: 98738,
+	has_incidents: false,
+	id: 35436,
+	organization_id: 509974,
+	priority: "high",
+	problem_id: 9873764,
+	raw_subject: "{{dc.printer_on_fire}}",
+	recipient: "support@company.com",
+	requester_id: 20978392,
+	satisfaction_rating: {
+		comment: "Great support!",
+		id: 1234,
+		score: "good"
+	},
+	sharing_agreement_ids: [84432],
+	status: "open",
+	subject: "Help, my printer is on fire!",
+	submitter_id: 76872,
+	tags: ["enterprise", "other_tag"],
+	type: "incident",
+	updated_at: "2011-05-05T10:38:52Z",
+	url: "https://company.zendesk.com/api/v2/tickets/35436.json",
+	via: mockVia
+};
+const mockTicketsResponse = {
+	count: 1,
+	tickets: [mockTicket]
+};
+const mockTicketResponse = {
+	count: 1,
+	ticket: mockTicket
+};
+//#endregion
+//#region src/search/search.mocks.ts
+const mockSearchResponseGroups = {
+	count: 1,
+	facets: null,
+	results: [mockGroup]
+};
+const mockSearchResponseTickets = {
+	count: 1,
+	facets: null,
+	results: [mockTicket]
+};
+const mockSearchResponseUsers = {
+	count: 1,
+	facets: null,
+	results: [mockUser]
+};
+//#endregion
+//#region src/search/index.ts
+var search_default = search_default$1;
+//#endregion
+//#region src/status/status.ts
+const operation$3 = "/api/v2/custom_statuses";
+const createStatus = (status, options) => exreq({
+	operation: operation$3,
+	id: options?.id,
+	method: options?.method || "post",
+	data: { custom_status: status },
+	options: {
+		...options,
+		headers: {
+			...options?.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+const getStatus = (...args) => {
+	const [id, options] = parseArgs(args);
+	return exreq({
+		operation: operation$3,
+		id,
+		options: {
+			...options,
+			headers: {
+				...options.headers,
+				Authorization: `Basic ${options.token}`
+			},
+			baseURL: setBaseURL("zendesk", appConf, options?.environment)
+		}
+	});
+};
+const updateStatus = (id, status, options) => createStatus(status, {
+	method: "put",
+	id,
+	...options
+});
+var status_default$1 = {
+	create: createStatus,
+	get: getStatus,
+	update: updateStatus
+};
+//#endregion
+//#region src/status/status.mocks.ts
+const mockDefaultStatus = {
+	active: true,
+	agent_label: "open",
+	description: "Customer needs a response quickly",
+	end_user_description: "Your ticket is being responded to",
+	end_user_label: "open",
+	status_category: "open"
+};
+const mockCustomStatus = {
+	active: true,
+	agent_label: "Responding quickly",
+	created_at: "2021-07-20T22:55:29Z",
+	default: false,
+	description: "Customer needs a response quickly",
+	end_user_description: "Your ticket is being responded to",
+	end_user_label: "Urgent processing",
+	id: 35436,
+	raw_agent_label: "Responding quickly",
+	raw_description: "Customer needs a response quickly",
+	raw_end_user_description: "Your ticket is being responded to",
+	raw_end_user_label: "Urgent processing",
+	status_category: "open",
+	updated_at: "2021-07-20T22:55:29Z"
+};
+const mockCustomStatusesResponse = {
+	count: 1,
+	custom_statuses: [mockCustomStatus]
+};
+const mockCustomStatusResponse = {
+	count: 1,
+	custom_status: mockCustomStatus
+};
+//#endregion
+//#region src/status/index.ts
+var status_default = { ...status_default$1 };
+//#endregion
+//#region src/tickets/comments.ts
+const operation$2 = "/api/v2/tickets";
+const createComment = (id, comment, options) => exreq({
+	operation: operation$2,
+	id,
+	method: options?.method || "post",
+	data: { ticket: { comment: { body: comment } } },
+	options: {
+		...options,
+		headers: {
+			...options?.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+const getComments = (ticket, options) => {
+	console.log({ ticket });
+	return exreq({
+		operation: `${operation$2}/${ticket}/comments`,
+		options: {
+			...options,
+			headers: {
+				...options.headers,
+				Authorization: `Basic ${options.token}`
+			},
+			baseURL: setBaseURL("zendesk", appConf, options?.environment)
+		}
+	});
+};
+var comments_default = {
+	create: createComment,
+	get: getComments
+};
+//#endregion
+//#region src/tickets/fields.ts
+const operation$1 = "/api/v2/ticket_fields";
+const createField = (field, options) => exreq({
+	operation: operation$1,
+	id: options?.id,
+	method: options?.method || "post",
+	data: { ticket_field: field },
+	options: {
+		...options,
+		headers: {
+			...options?.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+const getFields = (...args) => {
+	const [id, options] = parseArgs(args);
+	return exreq({
+		operation: operation$1,
+		id,
+		options: {
+			...options,
+			headers: {
+				...options.headers,
+				Authorization: `Basic ${options.token}`
+			},
+			baseURL: setBaseURL("zendesk", appConf, options?.environment)
+		}
+	});
+};
+const updateField = (id, field, options) => createField(field, {
+	method: "put",
+	id,
+	...options
+});
+const deleteField = (id, options) => exreq({
+	operation: operation$1,
+	id,
+	method: "delete",
+	options: {
+		...options,
+		headers: {
+			...options.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+var fields_default = {
+	create: createField,
+	get: getFields,
+	update: updateField,
+	delete: deleteField
+};
+//#endregion
+//#region src/tickets/tickets.ts
+const operation = "/api/v2/tickets";
+const createTicket = (ticket, options) => exreq({
+	operation,
+	id: options?.id,
+	method: options?.method || "post",
+	data: { ticket },
+	options: {
+		...options,
+		headers: {
+			...options?.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+const getTickets = (...args) => {
+	const [id, options] = parseArgs(args);
+	return exreq({
+		operation,
+		id,
+		options: {
+			...options,
+			params: { include: "custom_statuses" },
+			headers: {
+				...options.headers,
+				Authorization: `Basic ${options.token}`
+			},
+			baseURL: setBaseURL("zendesk", appConf, options?.environment)
+		}
+	});
+};
+const updateTicket = (id, ticket, options) => createTicket(ticket, {
+	method: "put",
+	id,
+	...options
+});
+const deleteTicket = (id, options) => exreq({
+	operation,
+	id,
+	method: "delete",
+	options: {
+		...options,
+		headers: {
+			...options.headers,
+			Authorization: `Basic ${options.token}`
+		},
+		baseURL: setBaseURL("zendesk", appConf, options?.environment)
+	}
+});
+var tickets_default$1 = {
+	create: createTicket,
+	get: getTickets,
+	update: updateTicket,
+	delete: deleteTicket
+};
+//#endregion
+//#region src/tickets/comments.mocks.ts
+const mockComment = {
+	attachments: [mockAttachment],
+	audit_id: 432567,
+	author_id: 123123,
+	body: "Thanks for your help!",
+	created_at: "2009-07-20T22:55:29Z",
+	id: 1274,
+	metadata: mockMetadata,
+	public: true,
+	type: "Comment"
+};
+const mockCommentResponse = { comments: [mockComment] };
+//#endregion
+//#region src/tickets/metrics.mocks.ts
+const mockTicketMetric = {
+	agent_wait_time_in_minutes: {
+		business: 737,
+		calendar: 2391
+	},
+	assigned_at: "2011-05-05T10:38:52Z",
+	assignee_stations: 1,
+	assignee_updated_at: "2011-05-06T10:38:52Z",
+	created_at: "2009-07-20T22:55:29Z",
+	custom_status_updated_at: "2011-05-09T10:38:52Z",
+	first_resolution_time_in_minutes: {
+		business: 737,
+		calendar: 2391
+	},
+	full_resolution_time_in_minutes: {
+		business: 737,
+		calendar: 2391
+	},
+	group_stations: 7,
+	id: 33,
+	initially_assigned_at: "2011-05-03T10:38:52Z",
+	latest_comment_added_at: "2011-05-09T10:38:52Z",
+	on_hold_time_in_minutes: {
+		business: 637,
+		calendar: 2290
+	},
+	reopens: 55,
+	replies: 322,
+	reply_time_in_minutes: {
+		business: 737,
+		calendar: 2391
+	},
+	reply_time_in_seconds: { calendar: 143460 },
+	requester_updated_at: "2011-05-07T10:38:52Z",
+	requester_wait_time_in_minutes: {
+		business: 737,
+		calendar: 2391
+	},
+	solved_at: "2011-05-09T10:38:52Z",
+	status_updated_at: "2011-05-04T10:38:52Z",
+	ticket_id: 4343,
+	updated_at: "2011-05-05T10:38:52Z"
+};
+//#endregion
+//#region src/tickets/index.ts
+var tickets_default = {
+	...tickets_default$1,
+	comments: comments_default,
+	fields: fields_default
+};
+//#endregion
+//#region src/utils.ts
+const createToken = (user, password) => Buffer.from(`${user}/token:${password}`).toString("base64");
+function setToken(user, password) {
+	const encoded = createToken(user, password);
+	axios.defaults.headers.common.Authorization = `Basic ${encoded}`;
+}
+//#endregion
+//#region src/index.ts
+var src_default = {
+	activities: activities_default,
+	search: search_default,
+	status: status_default,
+	tickets: tickets_default
+};
+//#endregion
+export { createToken, src_default as default, mockActivity, mockActivityResponse, mockAttachment, mockComment, mockCommentResponse, mockCustomField1, mockCustomField2, mockCustomFields, mockCustomStatus, mockCustomStatusResponse, mockCustomStatusesResponse, mockDefaultStatus, mockGroup, mockImage, mockMetadata, mockSearchResponseGroups, mockSearchResponseTickets, mockSearchResponseUsers, mockThumbnail, mockTicket, mockTicketField, mockTicketFieldResponse, mockTicketFieldsResponse, mockTicketMetric, mockTicketResponse, mockTicketsResponse, mockUser, mockVia, setToken };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@theholocron/zendesk-client",
+  "version": "0.0.0",
+  "description": "A TypeScript client for the Zendesk API",
+  "homepage": "https://github.com/theholocron/clients/tree/main/packages/zendesk-client#readme",
+  "bugs": "https://github.com/theholocron/clients/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theholocron/clients.git",
+    "directory": "packages/zendesk-client"
+  },
+  "license": "GPL-3.0",
+  "author": "Newton Koumantzelis",
+  "type": "module",
+  "main": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "axios": "^1.10.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@theholocron/eslint-config": "catalog:",
+    "@theholocron/tsconfig": "catalog:",
+    "@theholocron/tsdown-config": "catalog:",
+    "@theholocron/vitest-config": "catalog:",
+    "@vitest/coverage-v8": "catalog:",
+    "@vitest/eslint-plugin": "catalog:",
+    "eslint": "catalog:",
+    "eslint-plugin-n": "catalog:",
+    "globals": "catalog:",
+    "tsdown": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "./dist/index.mjs",
+    "types": "./dist/index.d.mts",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.mts",
+        "import": "./dist/index.mjs",
+        "default": "./dist/index.mjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "releases": "https://github.com/theholocron/clients/releases",
+  "wiki": "https://github.com/theholocron/clients/wiki"
+}