cogfy-messenger 0.1.3 → 0.1.5

package/dist/clients/conversations/conversations-client.d.ts

@@ -1,6 +1,6 @@
 import { BaseClient } from '../base-client';
-import { SendMessageCommand } from './types/send-message';
-import { GetConversationResult, GetMessagesResult, ListConversationsParams, ListConversationsResult, ListMessagesParams } from './types';
+import { SendMessageCommand, SendMessageResult } from './types/send-message';
+import { GetConversationResult, GetMessagesResult, ListConversationsParams, ListConversationsResult, ListMessagesParams, SendInteractiveOrderDetailsMessageCommand, SendInteractiveOrderDetailsMessageResult } from './types';
 export declare class ConversationsClient extends BaseClient {
     /**
      * Calls the GET /conversations/:id endpoint
@@ -20,5 +20,18 @@ export declare class ConversationsClient extends BaseClient {
      * @returns A list of all messages in the specified conversation
     */
     getMessages(params: ListMessagesParams): Promise<GetMessagesResult>;
-    sendMessage(id: string, payload: SendMessageCommand): Promise<any>;
+    /**
+     * Calls the POST /conversations/:id/messages/interactive/order-details endpoint
+     * @param id The ID of the conversation to send a message to
+     * @param payload The message payload to send
+     * @returns The response from the API
+    */
+    sendInteractiveOrderDetailsMessage(id: string, payload: SendInteractiveOrderDetailsMessageCommand): Promise<SendInteractiveOrderDetailsMessageResult>;
+    /**
+     * Calls the POST /conversations/:id/messages endpoint
+     * @param id The ID of the conversation to send a message to
+     * @param payload The message payload to send
+     * @returns The response from the API
+    */
+    sendMessage(id: string, payload: SendMessageCommand): Promise<SendMessageResult>;
 }

package/dist/clients/conversations/conversations-client.js

@@ -48,6 +48,23 @@ class ConversationsClient extends base_client_1.BaseClient {
             return axiosResponse.data;
         });
     }
+    /**
+     * Calls the POST /conversations/:id/messages/interactive/order-details endpoint
+     * @param id The ID of the conversation to send a message to
+     * @param payload The message payload to send
+     * @returns The response from the API
+    */
+    sendInteractiveOrderDetailsMessage(id, payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post(`/conversations/${id}/messages/interactive/order-details`, payload)).data;
+        });
+    }
+    /**
+     * Calls the POST /conversations/:id/messages endpoint
+     * @param id The ID of the conversation to send a message to
+     * @param payload The message payload to send
+     * @returns The response from the API
+    */
     sendMessage(id, payload) {
         return __awaiter(this, void 0, void 0, function* () {
             return (yield this.axios.post(`/conversations/${id}/messages`, payload)).data;

package/dist/clients/conversations/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from './get-conversation';
 export * from './get-messages';
-export * from './send-message';
 export * from './list-conversations';
+export * from './send-interactive-order-details-message';
+export * from './send-message';

package/dist/clients/conversations/types/index.js

@@ -16,5 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./get-conversation"), exports);
 __exportStar(require("./get-messages"), exports);
-__exportStar(require("./send-message"), exports);
 __exportStar(require("./list-conversations"), exports);
+__exportStar(require("./send-interactive-order-details-message"), exports);
+__exportStar(require("./send-message"), exports);

package/dist/clients/conversations/types/send-interactive-order-details-message.d.ts

@@ -0,0 +1,81 @@
+export type SendInteractiveOrderDetailsMessageCommand = {
+    content: InteractiveOrderDetailsContent;
+};
+export type SendInteractiveOrderDetailsMessageResult = {
+    id: string;
+};
+type Amount = {
+    value: number;
+    offset: number;
+    description?: string;
+};
+type PaymentSettingsTypePixDynamicCode = {
+    type: 'pix_dynamic_code';
+    pix_dynamic_code: {
+        code: string;
+        merchant_name: string;
+        key: string;
+        key_type: string;
+    };
+};
+type PaymentSettingsTypePaymentLink = {
+    type: 'payment_link';
+    payment_link: {
+        uri: string;
+    };
+};
+type PaymentSettingsTypeBoleto = {
+    type: 'boleto';
+    boleto: {
+        digitable_line: string;
+    };
+};
+type InteractiveOrderDetailsContent = {
+    type: 'order_details';
+    body: {
+        text: string;
+    };
+    action: {
+        name: string;
+        parameters: {
+            reference_id: string;
+            type: string;
+            payment_type: string;
+            payment_settings?: Array<PaymentSettingsTypePixDynamicCode | PaymentSettingsTypePaymentLink | PaymentSettingsTypeBoleto>;
+            currency: string;
+            total_amount: Amount;
+            order: {
+                status: string;
+                catalog_id?: string;
+                shipping?: Amount;
+                expiration?: {
+                    description: string;
+                    timestamp: string;
+                };
+                tax: Amount;
+                discount?: Amount & {
+                    discount_program_name?: string;
+                };
+                items: {
+                    retailer_id: string;
+                    name: string;
+                    amount: Amount;
+                    quantity: number;
+                    sale_amount?: Amount;
+                }[];
+                subtotal: Amount;
+            };
+        };
+    };
+    header?: {
+        type: 'image';
+        image: {
+            link: string;
+            provider?: string;
+        };
+    };
+    footer?: {
+        text: string;
+    };
+};
+export {};

package/dist/clients/conversations/types/send-interactive-order-details-message.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/index.d.ts

@@ -1,2 +1,6 @@
-export * from './contacts/types';
-export * from './tags/types';
+export * from './base-client';
+export * from './broadcasts';
+export * from './contacts';
+export * from './conversations';
+export * from './messages';
+export * from './tags';

package/dist/clients/index.js

@@ -14,5 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./contacts/types"), exports);
-__exportStar(require("./tags/types"), exports);
+__exportStar(require("./base-client"), exports);
+__exportStar(require("./broadcasts"), exports);
+__exportStar(require("./contacts"), exports);
+__exportStar(require("./conversations"), exports);
+__exportStar(require("./messages"), exports);
+__exportStar(require("./tags"), exports);

package/dist/clients/messages/index.d.ts

@@ -0,0 +1 @@
+export * from './messages-client';

package/dist/clients/messages/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./messages-client"), exports);

package/dist/clients/messages/messages-client.d.ts

@@ -0,0 +1,40 @@
+import { BaseClient } from '../base-client';
+import { SendInteractiveCtaUrlMessageCommand, SendInteractiveCtaUrlMessageResult, SendInteractiveOrderDetailsMessageCommand, SendInteractiveOrderDetailsMessageResult, SendInteractiveOrderStatusMessageCommand, SendInteractiveOrderStatusMessageResult, SendLocationMessageCommand, SendLocationMessageResult, SendTemplateMessageCommand, SendTemplateMessageResult, SendTextMessageCommand, SendTextMessageResult } from './types';
+export declare class MessagesClient extends BaseClient {
+    /**
+     * Calls the POST /messages/interactive/cta_url endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendInteractiveCtaUrl(payload: SendInteractiveCtaUrlMessageCommand): Promise<SendInteractiveCtaUrlMessageResult>;
+    /**
+     * Calls the POST /messages/interactive/order_details endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendInteractiveOrderDetails(payload: SendInteractiveOrderDetailsMessageCommand): Promise<SendInteractiveOrderDetailsMessageResult>;
+    /**
+     * Calls the POST /messages/interactive/order_status endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendInteractiveOrderStatus(payload: SendInteractiveOrderStatusMessageCommand): Promise<SendInteractiveOrderStatusMessageResult>;
+    /**
+     * Calls the POST /messages/location endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendLocation(payload: SendLocationMessageCommand): Promise<SendLocationMessageResult>;
+    /**
+     * Calls the POST /messages/template endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendTemplate(payload: SendTemplateMessageCommand): Promise<SendTemplateMessageResult>;
+    /**
+     * Calls the POST /messages/text endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendText(payload: SendTextMessageCommand): Promise<SendTextMessageResult>;
+}

package/dist/clients/messages/messages-client.js

@@ -0,0 +1,76 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessagesClient = void 0;
+const base_client_1 = require("../base-client");
+class MessagesClient extends base_client_1.BaseClient {
+    /**
+     * Calls the POST /messages/interactive/cta_url endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendInteractiveCtaUrl(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/messages/interactive/cta_url', payload)).data;
+        });
+    }
+    /**
+     * Calls the POST /messages/interactive/order_details endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendInteractiveOrderDetails(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/messages/interactive/order_details', payload)).data;
+        });
+    }
+    /**
+     * Calls the POST /messages/interactive/order_status endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendInteractiveOrderStatus(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/messages/interactive/order_status', payload)).data;
+        });
+    }
+    /**
+     * Calls the POST /messages/location endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendLocation(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/messages/location', payload)).data;
+        });
+    }
+    /**
+     * Calls the POST /messages/template endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendTemplate(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/messages/template', payload)).data;
+        });
+    }
+    /**
+     * Calls the POST /messages/text endpoint
+     * @param payload The message data to send
+     * @returns The result of the sent message
+     */
+    sendText(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/messages/text', payload)).data;
+        });
+    }
+}
+exports.MessagesClient = MessagesClient;

package/dist/clients/messages/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './send-interactive-cta-url';
+export * from './send-interactive-order-details';
+export * from './send-interactive-order-status';
+export * from './send-location';
+export * from './send-template';
+export * from './send-text';

package/dist/clients/messages/types/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./send-interactive-cta-url"), exports);
+__exportStar(require("./send-interactive-order-details"), exports);
+__exportStar(require("./send-interactive-order-status"), exports);
+__exportStar(require("./send-location"), exports);
+__exportStar(require("./send-template"), exports);
+__exportStar(require("./send-text"), exports);

package/dist/clients/messages/types/send-interactive-cta-url.d.ts

@@ -0,0 +1,26 @@
+export type SendInteractiveCtaUrlMessageCommand = {
+    from: string;
+    to: string;
+    interactive: {
+        type?: 'cta_url';
+        header?: {
+            type: 'text' | 'image' | 'video' | 'document';
+        };
+        body: {
+            text: string;
+        };
+        footer?: {
+            text: string;
+        };
+        action: {
+            name?: 'cta_url';
+            parameters: {
+                display_text: string;
+                url: string;
+            };
+        };
+    };
+};
+export type SendInteractiveCtaUrlMessageResult = {
+    id: string;
+};

package/dist/clients/messages/types/send-interactive-cta-url.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/messages/types/send-interactive-order-details.d.ts

@@ -0,0 +1,68 @@
+export type SendInteractiveOrderDetailsMessageCommand = {
+    from: string;
+    to: string;
+    interactive: {
+        type?: 'order_details';
+        header?: {
+            type: 'image';
+        };
+        body: {
+            text: string;
+        };
+        footer?: {
+            text: string;
+        };
+        action: {
+            name?: 'review_and_pay';
+            parameters: {
+                reference_id: string;
+                type: 'digital-goods' | 'physical-goods';
+                payment_type?: 'br';
+                payment_settings: Array<{
+                    type: 'pix_dynamic_code' | 'payment_link' | 'boleto';
+                    pix_dynamic_code?: {
+                        code: string;
+                        merchant_name: string;
+                        key: string;
+                        key_type: 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'EVP';
+                    };
+                    payment_link?: {
+                        uri: string;
+                    };
+                    boleto?: {
+                        digitable_line: string;
+                    };
+                }>;
+                currency?: 'BRL';
+                total_amount: number;
+                order: {
+                    status?: 'pending';
+                    catalog_id?: string;
+                    expiration?: {
+                        timestamp?: number;
+                        description: string;
+                    };
+                    items: Array<{
+                        retailer_id: string;
+                        name: string;
+                        amount: number;
+                        quantity?: number;
+                        sale_amount?: number;
+                    }>;
+                    subtotal: number;
+                    tax: number;
+                    shipping?: number;
+                    discount?: {
+                        value: number;
+                        offset?: number;
+                        description?: string;
+                        discount_program_name?: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export type SendInteractiveOrderDetailsMessageResult = {
+    id: string;
+};

package/dist/clients/messages/types/send-interactive-order-details.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/messages/types/send-interactive-order-status.d.ts

@@ -0,0 +1,33 @@
+export type SendInteractiveOrderStatusMessageCommand = {
+    from: string;
+    to: string;
+    interactive: {
+        type?: 'order_status';
+        header?: {
+            type: 'image';
+        };
+        body: {
+            text: string;
+        };
+        footer?: {
+            text: string;
+        };
+        action: {
+            name?: 'review_order';
+            parameters: {
+                reference_id: string;
+                order?: {
+                    status: 'pending' | 'processing' | 'partially-shipped' | 'shipped' | 'completed' | 'canceled';
+                    description?: string;
+                };
+                payment?: {
+                    status: 'pending' | 'captured' | 'failed';
+                    timestamp?: number;
+                };
+            };
+        };
+    };
+};
+export type SendInteractiveOrderStatusMessageResult = {
+    id: string;
+};

package/dist/clients/messages/types/send-interactive-order-status.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/messages/types/send-location.d.ts

@@ -0,0 +1,13 @@
+export type SendLocationMessageCommand = {
+    from: string;
+    to: string;
+    location: {
+        longitude: number;
+        latitude: number;
+        name?: string;
+        address?: string;
+    };
+};
+export type SendLocationMessageResult = {
+    id: string;
+};

package/dist/clients/messages/types/send-location.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/messages/types/send-template.d.ts

@@ -0,0 +1,19 @@
+export type SendTemplateMessageCommand = {
+    from: string;
+    to: string;
+    template: {
+        name: string;
+        language: {
+            code: string;
+        };
+        components: {
+            type: string;
+            sub_type?: string;
+            index?: number;
+            parameters: any[];
+        }[];
+    };
+};
+export type SendTemplateMessageResult = {
+    id: string;
+};

package/dist/clients/messages/types/send-template.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/messages/types/send-text.d.ts

@@ -0,0 +1,10 @@
+export type SendTextMessageCommand = {
+    from: string;
+    to: string;
+    text: {
+        body: string;
+    };
+};
+export type SendTextMessageResult = {
+    id: string;
+};

package/dist/clients/messages/types/send-text.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cogfy-messenger.d.ts

@@ -1,7 +1,4 @@
-import { ContactsClient } from './clients/contacts';
-import { TagsClient } from './clients/tags';
-import { ConversationsClient } from './clients/conversations';
-import { BroadcastsClient } from './clients/broadcasts';
+import { BroadcastsClient, ContactsClient, ConversationsClient, MessagesClient, TagsClient } from './clients';
 export type CogfyMessengerOptions = {
     apiKey: string;
     baseURL?: string;
@@ -10,6 +7,7 @@ export declare class CogfyMessenger {
     broadcasts: BroadcastsClient;
     contacts: ContactsClient;
     conversations: ConversationsClient;
+    messages: MessagesClient;
     tags: TagsClient;
     constructor(options: CogfyMessengerOptions);
 }

package/dist/cogfy-messenger.js

@@ -5,10 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CogfyMessenger = void 0;
 const axios_1 = __importDefault(require("axios"));
-const contacts_1 = require("./clients/contacts");
-const tags_1 = require("./clients/tags");
-const conversations_1 = require("./clients/conversations");
-const broadcasts_1 = require("./clients/broadcasts");
+const clients_1 = require("./clients");
 const DEFAULT_BASE_URL = 'https://messenger-public-api.cogfy.com';
 class CogfyMessenger {
     constructor(options) {
@@ -20,10 +17,11 @@ class CogfyMessenger {
                 }
             })
         };
-        this.broadcasts = new broadcasts_1.BroadcastsClient(clientOptions);
-        this.contacts = new contacts_1.ContactsClient(clientOptions);
-        this.conversations = new conversations_1.ConversationsClient(clientOptions);
-        this.tags = new tags_1.TagsClient(clientOptions);
+        this.broadcasts = new clients_1.BroadcastsClient(clientOptions);
+        this.contacts = new clients_1.ContactsClient(clientOptions);
+        this.conversations = new clients_1.ConversationsClient(clientOptions);
+        this.messages = new clients_1.MessagesClient(clientOptions);
+        this.tags = new clients_1.TagsClient(clientOptions);
     }
 }
 exports.CogfyMessenger = CogfyMessenger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cogfy-messenger",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "main": "dist/index.js",
   "scripts": {
     "build": "rimraf dist && tsc",