@fiado/api-invoker 5.11.0 → 5.12.0

package/bin/zendesk/ZendeskApi.d.ts

@@ -2,6 +2,7 @@ import { IHttpRequest } from "@fiado/http-client";
 import { IZendeskApi } from "./interfaces/IZendeskApi.js";
 type FiadoApiResponse<T> = import('@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse.js').default<T>;
 import { HelpdeskCreateUserRequest, HelpdeskCreateTicketRequest } from '@fiado/type-kit/bin/helpdesk/index.js';
+import { SendProactiveMessageRequest, ISendProactiveMessageResponse } from '@fiado/type-kit/bin/zendeskMessaging/index.js';
 export declare class ZendeskApi implements IZendeskApi {
     private httpRequest;
     private readonly baseUrl;
@@ -11,5 +12,6 @@ export declare class ZendeskApi implements IZendeskApi {
     deleteByDirectoryId(directoryId: string): Promise<FiadoApiResponse<{
         deletedCount: number;
     }>>;
+    sendProactiveMessage(data: SendProactiveMessageRequest): Promise<FiadoApiResponse<ISendProactiveMessageResponse>>;
 }
 export {};

package/bin/zendesk/ZendeskApi.js

@@ -31,6 +31,10 @@ let ZendeskApi = class ZendeskApi {
         const url = `${this.baseUrl}private/directory/${directoryId}`;
         return await this.httpRequest.delete(url);
     }
+    async sendProactiveMessage(data) {
+        const url = `${this.baseUrl}messaging/send-proactive`;
+        return await this.httpRequest.post(url, data);
+    }
 };
 ZendeskApi = __decorate([
     injectable(),

package/bin/zendesk/interfaces/IZendeskApi.d.ts

@@ -1,5 +1,6 @@
 type FiadoApiResponse<T> = import('@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse.js').default<T>;
 import { HelpdeskCreateTicketRequest, HelpdeskCreateUserRequest } from '@fiado/type-kit/bin/helpdesk/index.js';
+import { SendProactiveMessageRequest, ISendProactiveMessageResponse } from '@fiado/type-kit/bin/zendeskMessaging/index.js';
 /**
  * Interfaz para el servicio de Zendesk
  */
@@ -14,5 +15,11 @@ export interface IZendeskApi {
     deleteByDirectoryId(directoryId: string): Promise<FiadoApiResponse<{
         deletedCount: number;
     }>>;
+    /**
+     * Envia un mensaje proactivo a un usuario via Zendesk Messaging (Sunshine Conversations).
+     * Crea (o reutiliza) el usuario y la conversacion en Sunshine a partir del directoryId.
+     * @param data directoryId + message (displayName opcional).
+     */
+    sendProactiveMessage(data: SendProactiveMessageRequest): Promise<FiadoApiResponse<ISendProactiveMessageResponse>>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/api-invoker",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "description": "Sirve como un puente entre diferentes funciones lambda, facilitando la comunicación entre ellas a través de invocaciones http",
   "type": "module",
   "main": "bin/index.js",

package/src/zendesk/ZendeskApi.ts

@@ -4,6 +4,7 @@ import { IHttpRequest } from "@fiado/http-client";
 import { IZendeskApi } from "./interfaces/IZendeskApi.js";
 type FiadoApiResponse<T> = import('@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse.js').default<T>;
 import { HelpdeskCreateUserRequest, HelpdeskCreateTicketRequest } from '@fiado/type-kit/bin/helpdesk/index.js';
+import { SendProactiveMessageRequest, ISendProactiveMessageResponse } from '@fiado/type-kit/bin/zendeskMessaging/index.js';
 dotenv.config();
 
 @injectable()
@@ -26,4 +27,9 @@ export class ZendeskApi implements IZendeskApi {
         const url = `${this.baseUrl}private/directory/${directoryId}`;
         return await this.httpRequest.delete<FiadoApiResponse<{ deletedCount: number }>>(url);
     }
+
+    async sendProactiveMessage(data: SendProactiveMessageRequest): Promise<FiadoApiResponse<ISendProactiveMessageResponse>> {
+        const url: string = `${this.baseUrl}messaging/send-proactive`;
+        return await this.httpRequest.post<FiadoApiResponse<ISendProactiveMessageResponse>>(url, data);
+    }
 }

package/src/zendesk/interfaces/IZendeskApi.ts

@@ -1,5 +1,6 @@
 type FiadoApiResponse<T> = import('@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse.js').default<T>;
 import { HelpdeskCreateTicketRequest, HelpdeskCreateUserRequest } from '@fiado/type-kit/bin/helpdesk/index.js';
+import { SendProactiveMessageRequest, ISendProactiveMessageResponse } from '@fiado/type-kit/bin/zendeskMessaging/index.js';
 
 /**
  * Interfaz para el servicio de Zendesk
@@ -15,4 +16,11 @@ export interface IZendeskApi {
      */
     // TODO(type-kit): swap a Directory.DeleteByDirectoryResponse cuando se publique
     deleteByDirectoryId(directoryId: string): Promise<FiadoApiResponse<{ deletedCount: number }>>;
+
+    /**
+     * Envia un mensaje proactivo a un usuario via Zendesk Messaging (Sunshine Conversations).
+     * Crea (o reutiliza) el usuario y la conversacion en Sunshine a partir del directoryId.
+     * @param data directoryId + message (displayName opcional).
+     */
+    sendProactiveMessage(data: SendProactiveMessageRequest): Promise<FiadoApiResponse<ISendProactiveMessageResponse>>;
 }