cogfy-messenger 0.1.2 → 0.1.4

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

@@ -0,0 +1,28 @@
+import { BaseClient } from '../base-client';
+import { CreateBroadcastCommand, CreateBroadcastResult, GetBroadcastResult, ListBroadcastsResult, SendBroadcastCommand } from './types';
+export declare class BroadcastsClient extends BaseClient {
+    /**
+     * Calls the POST /broadcasts endpoint to create a new broadcast
+     * @param broadcast The broadcast data to create
+     * @returns The created broadcast
+     */
+    create(broadcast: CreateBroadcastCommand): Promise<CreateBroadcastResult>;
+    /**
+     * Calls the GET /broadcasts/:id endpoint to retrieve a broadcast by ID
+     * @param id The ID of the broadcast to retrieve
+     * @returns The requested broadcast
+     */
+    get(id: string): Promise<GetBroadcastResult>;
+    /**
+     * Calls the GET /broadcasts endpoint to retrieve all broadcasts
+     * @returns A list of all broadcasts
+     */
+    list(): Promise<ListBroadcastsResult>;
+    /**
+     * Calls the POST /broadcasts/:id/send endpoint to send a broadcast
+     * @param id The ID of the broadcast to send
+     * @param command The send broadcast command
+     * @returns A promise that resolves when the broadcast is sent
+     */
+    send(id: string, command: SendBroadcastCommand): Promise<void>;
+}

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

@@ -0,0 +1,56 @@
+"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.BroadcastsClient = void 0;
+const base_client_1 = require("../base-client");
+class BroadcastsClient extends base_client_1.BaseClient {
+    /**
+     * Calls the POST /broadcasts endpoint to create a new broadcast
+     * @param broadcast The broadcast data to create
+     * @returns The created broadcast
+     */
+    create(broadcast) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.post('/broadcasts', broadcast)).data;
+        });
+    }
+    /**
+     * Calls the GET /broadcasts/:id endpoint to retrieve a broadcast by ID
+     * @param id The ID of the broadcast to retrieve
+     * @returns The requested broadcast
+     */
+    get(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.get(`/broadcasts/${id}`)).data;
+        });
+    }
+    /**
+     * Calls the GET /broadcasts endpoint to retrieve all broadcasts
+     * @returns A list of all broadcasts
+     */
+    list() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.axios.get('/broadcasts')).data;
+        });
+    }
+    /**
+     * Calls the POST /broadcasts/:id/send endpoint to send a broadcast
+     * @param id The ID of the broadcast to send
+     * @param command The send broadcast command
+     * @returns A promise that resolves when the broadcast is sent
+     */
+    send(id, command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.post(`/broadcasts/${id}/send`, command);
+        });
+    }
+}
+exports.BroadcastsClient = BroadcastsClient;

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

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

package/dist/clients/broadcasts/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("./broadcasts-client"), exports);

package/dist/clients/broadcasts/types/broadcast-status.d.ts

@@ -0,0 +1 @@
+export type BroadcastStatus = 'draft' | 'failed' | 'pending' | 'sent';

package/dist/clients/broadcasts/types/broadcast-status.js

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

package/dist/clients/broadcasts/types/create-broadcast.d.ts

@@ -0,0 +1,16 @@
+export type CreateBroadcastCommand = {
+    type: 'text';
+    title: string;
+    content: string;
+    phoneNumberId: string;
+    contactsQuery?: {
+        tags?: ({
+            id: string;
+        } | {
+            name: string;
+        })[];
+    };
+};
+export type CreateBroadcastResult = {
+    id: string;
+};

package/dist/clients/broadcasts/types/create-broadcast.js

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

package/dist/clients/broadcasts/types/get-broadcast.d.ts

@@ -0,0 +1,6 @@
+import { BroadcastStatus } from './broadcast-status';
+export type GetBroadcastResult = {
+    id: string;
+    status: BroadcastStatus;
+    createDate: string;
+};

package/dist/clients/broadcasts/types/get-broadcast.js

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

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

@@ -0,0 +1,5 @@
+export * from './broadcast-status';
+export * from './create-broadcast';
+export * from './get-broadcast';
+export * from './list-broadcasts';
+export * from './send-broadcast';

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

@@ -0,0 +1,21 @@
+"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("./broadcast-status"), exports);
+__exportStar(require("./create-broadcast"), exports);
+__exportStar(require("./get-broadcast"), exports);
+__exportStar(require("./list-broadcasts"), exports);
+__exportStar(require("./send-broadcast"), exports);

package/dist/clients/broadcasts/types/list-broadcasts.d.ts

@@ -0,0 +1,8 @@
+import { BroadcastStatus } from './broadcast-status';
+export type ListBroadcastsResult = {
+    data: {
+        id: string;
+        status: BroadcastStatus;
+        createDate: string;
+    }[];
+};

package/dist/clients/broadcasts/types/list-broadcasts.js

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

package/dist/clients/broadcasts/types/send-broadcast.d.ts

@@ -0,0 +1,3 @@
+export type SendBroadcastCommand = {
+    broadcastId: string;
+};

package/dist/clients/broadcasts/types/send-broadcast.js

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

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/cogfy-messenger.d.ts

@@ -1,11 +1,13 @@
 import { ContactsClient } from './clients/contacts';
 import { TagsClient } from './clients/tags';
 import { ConversationsClient } from './clients/conversations';
+import { BroadcastsClient } from './clients/broadcasts';
 export type CogfyMessengerOptions = {
     apiKey: string;
     baseURL?: string;
 };
 export declare class CogfyMessenger {
+    broadcasts: BroadcastsClient;
     contacts: ContactsClient;
     conversations: ConversationsClient;
     tags: TagsClient;

package/dist/cogfy-messenger.js

@@ -8,6 +8,7 @@ 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 DEFAULT_BASE_URL = 'https://messenger-public-api.cogfy.com';
 class CogfyMessenger {
     constructor(options) {
@@ -19,6 +20,7 @@ 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);

package/package.json

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