@squidcloud/freshdesk-client 1.0.430

package/dist/connectors/freshdesk/common/src/freshdesk-types.d.ts

@@ -0,0 +1,212 @@
+import { IntegrationId } from '../../../../internal-common/src/public-types/communication.public-types';
+/**
+ * Freshdesk API Types - Shared between backend and client
+ */
+export type FreshdeskPriority = 1 | 2 | 3 | 4;
+export declare const PRIORITY_LABELS: Record<FreshdeskPriority, string>;
+export type FreshdeskStatus = 2 | 3 | 4 | 5;
+export declare const STATUS_LABELS: Record<FreshdeskStatus, string>;
+export type FreshdeskSource = 1 | 2 | 3 | 7 | 8 | 9 | 10;
+export declare const SOURCE_LABELS: Record<FreshdeskSource, string>;
+export interface FreshdeskContact {
+    id: number;
+    name: string;
+    email: string;
+    phone?: string;
+    mobile?: string;
+    company_id?: number;
+    active: boolean;
+    job_title?: string;
+    language?: string;
+    time_zone?: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface FreshdeskCompany {
+    id: number;
+    name: string;
+    description?: string;
+    domains?: Array<string>;
+    created_at: string;
+    updated_at: string;
+}
+export interface FreshdeskAgent {
+    id: number;
+    contact: {
+        name: string;
+        email: string;
+        phone?: string;
+        mobile?: string;
+        job_title?: string;
+        active: boolean;
+    };
+    available: boolean;
+    occasional: boolean;
+    ticket_scope: number;
+    group_ids: Array<number>;
+    role_ids: Array<number>;
+    created_at: string;
+    updated_at: string;
+}
+export interface FreshdeskGroup {
+    id: number;
+    name: string;
+    description?: string;
+    agent_ids: Array<number>;
+    auto_ticket_assign: boolean;
+    escalate_to?: number;
+    created_at: string;
+    updated_at: string;
+}
+export interface FreshdeskAttachment {
+    id: number;
+    name: string;
+    content_type: string;
+    size: number;
+    created_at: string;
+    updated_at: string;
+    attachment_url: string;
+}
+export interface FreshdeskConversation {
+    id: number;
+    body: string;
+    body_text: string;
+    incoming: boolean;
+    private: boolean;
+    user_id: number;
+    support_email?: string;
+    source: number;
+    ticket_id: number;
+    to_emails?: Array<string>;
+    from_email?: string;
+    cc_emails?: Array<string>;
+    bcc_emails?: Array<string>;
+    attachments?: Array<FreshdeskAttachment>;
+    created_at: string;
+    updated_at: string;
+}
+export interface FreshdeskTicket {
+    id: number;
+    subject: string;
+    description: string;
+    description_text: string;
+    status: FreshdeskStatus;
+    priority: FreshdeskPriority;
+    source: FreshdeskSource;
+    requester_id: number;
+    responder_id?: number;
+    company_id?: number;
+    group_id?: number;
+    type?: string;
+    tags?: Array<string>;
+    due_by?: string;
+    fr_due_by?: string;
+    is_escalated: boolean;
+    spam: boolean;
+    email_config_id?: number;
+    product_id?: number;
+    custom_fields?: Record<string, unknown>;
+    created_at: string;
+    updated_at: string;
+}
+export interface FreshdeskTicketDetails {
+    detailsAsString: string;
+    ticket: FreshdeskTicket;
+    conversations: Array<FreshdeskConversation>;
+}
+export type RelatedTicketsMode = 'RESOLVED_OR_CLOSED' | 'ALL' | 'NONE';
+export declare const RELATED_TICKETS_MODE_ENUM: Array<string>;
+/** Request to search Freshdesk tickets by text */
+export interface SearchFreshdeskTicketsRequest {
+    /** The ID of the Freshdesk integration */
+    integrationId: IntegrationId;
+    /** The search query to find tickets */
+    query: string;
+    /** Maximum number of tickets to return (default: 50) */
+    limit?: number;
+}
+/** Request to get details of a Freshdesk ticket */
+export interface GetFreshdeskTicketRequest {
+    /** The ID of the Freshdesk integration */
+    integrationId: IntegrationId;
+    /** The Freshdesk ticket ID */
+    ticketId: number;
+    /** Whether to include related tickets in the response */
+    relatedTicketsMode?: RelatedTicketsMode;
+}
+/** Request to create a Freshdesk ticket */
+export interface CreateFreshdeskTicketRequest {
+    /** The ID of the Freshdesk integration */
+    integrationId: IntegrationId;
+    /** The subject/title of the ticket */
+    subject: string;
+    /** The description of the ticket */
+    description: string;
+    /** Email of the requester */
+    email: string;
+    /** Priority (1=Low, 2=Medium, 3=High, 4=Urgent) */
+    priority?: FreshdeskPriority;
+    /** Status (2=Open, 3=Pending, 4=Resolved, 5=Closed) */
+    status?: FreshdeskStatus;
+    /** Tags to apply to the ticket */
+    tags?: Array<string>;
+    /** Ticket type */
+    type?: string;
+}
+/** Request to update a Freshdesk ticket */
+export interface UpdateFreshdeskTicketRequest {
+    /** The ID of the Freshdesk integration */
+    integrationId: IntegrationId;
+    /** The Freshdesk ticket ID */
+    ticketId: number;
+    /** New subject for the ticket */
+    subject?: string;
+    /** New description for the ticket */
+    description?: string;
+    /** New priority */
+    priority?: FreshdeskPriority;
+    /** New status */
+    status?: FreshdeskStatus;
+    /** Tags to set on the ticket */
+    tags?: Array<string>;
+    /** Ticket type */
+    type?: string;
+}
+/** Request to reply to a Freshdesk ticket */
+export interface ReplyToFreshdeskTicketRequest {
+    /** The ID of the Freshdesk integration */
+    integrationId: IntegrationId;
+    /** The Freshdesk ticket ID */
+    ticketId: number;
+    /** The reply text (HTML supported) */
+    body: string;
+    /** Whether this is a private note (default: false) */
+    private?: boolean;
+}
+/** Request to add a note to a Freshdesk ticket */
+export interface AddFreshdeskNoteRequest {
+    /** The ID of the Freshdesk integration */
+    integrationId: IntegrationId;
+    /** The Freshdesk ticket ID */
+    ticketId: number;
+    /** The note text */
+    body: string;
+    /** Whether this is a private note (default: true) */
+    private?: boolean;
+}
+/** Response from Freshdesk ticket operations */
+export interface FreshdeskTicketResponse {
+    /** Ticket ID */
+    id: number;
+    /** Ticket subject */
+    subject: string;
+    /** Ticket URL */
+    url: string;
+}
+/** Response with ticket details as string */
+export interface FreshdeskTicketDetailsResponse {
+    /** Ticket ID */
+    id: number;
+    /** Ticket details as formatted string */
+    details: string;
+}

package/dist/connectors/freshdesk/freshdesk-client/src/freshdesk-client.d.ts

@@ -0,0 +1,110 @@
+import { IntegrationId, Squid } from '@squidcloud/client';
+import { FreshdeskPriority, FreshdeskStatus, FreshdeskTicketResponse, RelatedTicketsMode } from '../../common/src/freshdesk-types';
+/**
+ * Client for interacting with the Freshdesk connector.
+ * Provides methods for searching, creating, updating, and managing Freshdesk tickets.
+ */
+export declare class FreshdeskClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * Creates a new FreshdeskClient instance.
+     * @param squid - The Squid client instance
+     * @param integrationId - The ID of the Freshdesk integration to use
+     */
+    constructor(squid: Squid, integrationId: IntegrationId);
+    /**
+     * Searches for Freshdesk tickets matching a text query.
+     * @param query - The search query to find tickets
+     * @param limit - Maximum number of tickets to return (default: 50)
+     * @returns Ticket search results as a formatted string
+     */
+    searchTickets(query: string, limit?: number): Promise<string>;
+    /**
+     * Gets detailed information about a specific Freshdesk ticket.
+     * @param ticketId - The Freshdesk ticket ID
+     * @param relatedTicketsMode - Whether to include related tickets (default: 'RESOLVED_OR_CLOSED')
+     * @returns Ticket details as a formatted string
+     */
+    getTicketDetails(ticketId: number, relatedTicketsMode?: RelatedTicketsMode): Promise<string>;
+    /**
+     * Creates a new Freshdesk ticket.
+     * @param subject - The subject/title of the ticket
+     * @param description - The description of the ticket
+     * @param email - Email of the requester
+     * @param options - Additional options (priority, status, tags, type)
+     * @returns The created ticket information
+     */
+    createTicket(subject: string, description: string, email: string, options?: {
+        priority?: FreshdeskPriority;
+        status?: FreshdeskStatus;
+        tags?: Array<string>;
+        type?: string;
+    }): Promise<FreshdeskTicketResponse>;
+    /**
+     * Updates an existing Freshdesk ticket.
+     * @param ticketId - The Freshdesk ticket ID
+     * @param updates - The fields to update
+     * @returns The updated ticket information
+     */
+    updateTicket(ticketId: number, updates: {
+        subject?: string;
+        description?: string;
+        priority?: FreshdeskPriority;
+        status?: FreshdeskStatus;
+        tags?: Array<string>;
+        type?: string;
+    }): Promise<FreshdeskTicketResponse>;
+    /**
+     * Replies to a Freshdesk ticket.
+     * @param ticketId - The Freshdesk ticket ID
+     * @param body - The reply text (HTML supported)
+     * @param isPrivate - Whether this is a private note (default: false)
+     * @returns The conversation ID of the reply
+     */
+    replyToTicket(ticketId: number, body: string, isPrivate?: boolean): Promise<{
+        conversationId: number;
+    }>;
+    /**
+     * Adds a private note to a Freshdesk ticket.
+     * @param ticketId - The Freshdesk ticket ID
+     * @param body - The note text
+     * @param isPrivate - Whether this is a private note (default: true)
+     * @returns The conversation ID of the note
+     */
+    addNote(ticketId: number, body: string, isPrivate?: boolean): Promise<{
+        conversationId: number;
+    }>;
+    /**
+     * Changes the status of a Freshdesk ticket.
+     * @param ticketId - The Freshdesk ticket ID
+     * @param status - The new status (2=Open, 3=Pending, 4=Resolved, 5=Closed)
+     * @returns The updated ticket information
+     */
+    changeStatus(ticketId: number, status: FreshdeskStatus): Promise<FreshdeskTicketResponse>;
+    /**
+     * Changes the priority of a Freshdesk ticket.
+     * @param ticketId - The Freshdesk ticket ID
+     * @param priority - The new priority (1=Low, 2=Medium, 3=High, 4=Urgent)
+     * @returns The updated ticket information
+     */
+    changePriority(ticketId: number, priority: FreshdeskPriority): Promise<FreshdeskTicketResponse>;
+    /**
+     * Resolves a Freshdesk ticket by setting its status to Resolved (4).
+     * @param ticketId - The Freshdesk ticket ID
+     * @returns The updated ticket information
+     */
+    resolveTicket(ticketId: number): Promise<FreshdeskTicketResponse>;
+    /**
+     * Closes a Freshdesk ticket by setting its status to Closed (5).
+     * @param ticketId - The Freshdesk ticket ID
+     * @returns The updated ticket information
+     */
+    closeTicket(ticketId: number): Promise<FreshdeskTicketResponse>;
+    /**
+     * Reopens a Freshdesk ticket by setting its status to Open (2).
+     * @param ticketId - The Freshdesk ticket ID
+     * @returns The updated ticket information
+     */
+    reopenTicket(ticketId: number): Promise<FreshdeskTicketResponse>;
+}

package/dist/connectors/freshdesk/freshdesk-client/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from '../../common/src/freshdesk-types';
+export * from './freshdesk-client';

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,i)=>{for(var n in i)e.o(i,n)&&!e.o(t,n)&&Object.defineProperty(t,n,{enumerable:!0,get:i[n]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{FreshdeskClient:()=>c,PRIORITY_LABELS:()=>i,RELATED_TICKETS_MODE_ENUM:()=>s,SOURCE_LABELS:()=>r,STATUS_LABELS:()=>n});const i={1:"Low",2:"Medium",3:"High",4:"Urgent"},n={2:"Open",3:"Pending",4:"Resolved",5:"Closed"},r={1:"Email",2:"Portal",3:"Phone",7:"Chat",8:"Mobihelp",9:"Feedback Widget",10:"Outbound Email"},s=["RESOLVED_OR_CLOSED","ALL","NONE"];class c{constructor(e,t){this.squid=e,this.integrationId=t}async searchTickets(e,t=50){const i={integrationId:this.integrationId,query:e,limit:t};return this.squid.executeFunction("searchFreshdeskTicketsExecutable",i)}async getTicketDetails(e,t="RESOLVED_OR_CLOSED"){const i={integrationId:this.integrationId,ticketId:e,relatedTicketsMode:t};return this.squid.executeFunction("getFreshdeskTicketDetailsExecutable",i)}async createTicket(e,t,i,n){const r={integrationId:this.integrationId,subject:e,description:t,email:i,...n};return this.squid.executeFunction("createFreshdeskTicketExecutable",r)}async updateTicket(e,t){const i={integrationId:this.integrationId,ticketId:e,...t};return this.squid.executeFunction("updateFreshdeskTicketExecutable",i)}async replyToTicket(e,t,i=!1){const n={integrationId:this.integrationId,ticketId:e,body:t,private:i};return this.squid.executeFunction("replyToFreshdeskTicketExecutable",n)}async addNote(e,t,i=!0){const n={integrationId:this.integrationId,ticketId:e,body:t,private:i};return this.squid.executeFunction("addFreshdeskNoteExecutable",n)}async changeStatus(e,t){return this.updateTicket(e,{status:t})}async changePriority(e,t){return this.updateTicket(e,{priority:t})}async resolveTicket(e){return this.changeStatus(e,4)}async closeTicket(e){return this.changeStatus(e,5)}async reopenTicket(e){return this.changeStatus(e,2)}}var a=exports;for(var o in t)a[o]=t[o];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();

package/dist/internal-common/src/public-types/communication.public-types.d.ts

@@ -0,0 +1,30 @@
+/** A type alias for an application id. */
+export type AppId = string;
+/** A tuple of environment identifiers like 'dev' or 'prod'. */
+export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
+/** A type representing valid environment identifiers derived from ENVIRONMENT_IDS. */
+export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
+/** A type alias for a squid developer identifier. */
+export type SquidDeveloperId = string;
+/** A type alias for an integration id. */
+export type IntegrationId = string;
+/** A type alias for a client identifier. */
+export type ClientId = string;
+/** A type alias for a squid document identifier. */
+export type SquidDocId = string;
+/** A type alias for a client request identifier. */
+export type ClientRequestId = string;
+/** ID of AI agent. Also known as AI profile id. */
+export type AiAgentId = string;
+/** App-level ID of AI Knowledge Base */
+export type AiKnowledgeBaseId = string;
+/**
+ * The built-in agent id. Cannot be customized.
+ * @category AI
+ */
+export declare const BUILT_IN_AGENT_ID = "built_in_agent";
+/**
+ * A type alias for an AI context identifier.
+ * @category AI
+ */
+export type AiContextId = string;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@squidcloud/freshdesk-client",
+  "version": "1.0.430",
+  "description": "Squid Freshdesk Client - SDK for interacting with the Freshdesk connector",
+  "main": "dist/index.js",
+  "types": "dist/freshdesk-client/src/index.d.ts",
+  "scripts": {
+    "prebuild": "del-cli dist",
+    "build": "webpack --mode=production",
+    "lint": "eslint",
+    "publish:public": "npm run build && npm publish --access public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "keywords": [
+    "squid",
+    "freshdesk",
+    "support-tickets",
+    "connector"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "assertic": "^1.3.0",
+    "@squidcloud/client": "^1.0.430"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}