@agenus-io/pixel-backend-sdk 1.1.0 → 1.1.2

package/README.md

@@ -207,9 +207,9 @@ type PurchaseSendType = "SALES_APPROVED" | "SALES_APPROVED_AND_PENDING";
 type PurchaseValueType = "SALE_VALUE" | "COMMISSION";
 ```
 
-### `InitiateCheckoutDetection`
+### `PixelDetection`
 ```typescript
-type InitiateCheckoutDetection = "AUTOMATIC" | "CONTAINS_TEXT" | "CONTAINS_CSS" | "CONTAINS_URL";
+type PixelDetection = "AUTOMATIC" | "CONTAINS_TEXT" | "CONTAINS_CSS" | "CONTAINS_URL";
 ```
 
 ### `SendIp`

package/dist/Class/index.d.ts

@@ -1,5 +1,5 @@
 import type { AWSConfig, SendSaleParams } from "../config";
-import { ICreatePixelDTO, IGetOnePixelDTO, IGetPixelDTO, IDeletePixelDTO, IUpdatePixelDTO, IPixelSdk, IUpdateOffersDTO, IMetricsDTO } from './interface';
+import { ICreatePixelDTO, IGetOnePixelDTO, IGetPixelDTO, IDeletePixelDTO, IUpdatePixelDTO, IPixelSdk, IUpdateOffersDTO, IMetricsDTO, IFunilSummaryDTO } from './interface';
 /**
  * Classe responsável por com vendas e pixels
  */
@@ -29,4 +29,5 @@ export declare class PixelSDK implements IPixelSdk {
     GetOne({ id, workSpaceId }: IGetOnePixelDTO.Params): Promise<IGetOnePixelDTO.Result>;
     UpdateOffers({ id, workspaceId, offerIds, type }: IUpdateOffersDTO.Params): Promise<void>;
     Metrics({ workSpaceId, platform, productIds, offerIds, filter }: IMetricsDTO.Params): Promise<IMetricsDTO.Result>;
+    FunilSummary({ workSpaceId, startDate, endDate, campaigns }: IFunilSummaryDTO.Params): Promise<IFunilSummaryDTO.Result>;
 }

package/dist/Class/index.js

@@ -240,5 +240,28 @@ class PixelSDK {
             throw "Erro ao obter métricas";
         }
     }
+    async FunilSummary({ workSpaceId, startDate, endDate, campaigns }) {
+        try {
+            const token = {
+                appId: this.appId,
+                secretToken: this.appToken,
+                workSpaceId: workSpaceId,
+            };
+            const response = await axios_1.default.get(`${this.apiUrl}/pixels/metrics/funil/summary`, {
+                headers: { "app-id": token.appId, "app-secret-token": token.secretToken, "work-space-id": token.workSpaceId },
+                params: { startDate, endDate, campaigns },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError) {
+                console.log(error.response?.data);
+            }
+            else {
+                console.log(error);
+            }
+            throw "Erro ao obter resumo da funil";
+        }
+    }
 }
 exports.PixelSDK = PixelSDK;

package/dist/Class/interface.d.ts

@@ -1,4 +1,4 @@
-import { InitiateCheckoutDetection, MarketingPlatform, PurchaseSendType, PurchaseValueType, SendIp } from '../types';
+import { PixelDetection, MarketingPlatform, PurchaseSendType, PurchaseValueType, SendIp } from '../types';
 interface CreatePixel {
     title: string;
     status: boolean;
@@ -6,8 +6,10 @@ interface CreatePixel {
     sendLeadText?: string;
     addToCart: boolean;
     addToCartText?: string;
+    addToCartDetection: PixelDetection;
+    sendLeadDetection: PixelDetection;
     initiateCheckout: boolean;
-    initiateCheckoutDetection: InitiateCheckoutDetection;
+    initiateCheckoutDetection: PixelDetection;
     initiateCheckoutDetectionText?: string;
     purchaseSendType: PurchaseSendType;
     purchaseValueType: PurchaseValueType;
@@ -84,7 +86,7 @@ export declare namespace IGetPixelDTO {
             addToCart: boolean;
             addToCartText: string | null;
             initiateCheckout: boolean;
-            initiateCheckoutDetection: InitiateCheckoutDetection;
+            initiateCheckoutDetection: PixelDetection;
             initiateCheckoutDetectionText: string | null;
             purchaseSendType: PurchaseSendType;
             purchaseValueType: PurchaseValueType;
@@ -142,7 +144,7 @@ export declare namespace IGetOnePixelDTO {
             addToCart: boolean;
             addToCartText: string | null;
             initiateCheckout: boolean;
-            initiateCheckoutDetection: InitiateCheckoutDetection;
+            initiateCheckoutDetection: PixelDetection;
             initiateCheckoutDetectionText: string | null;
             purchaseSendType: PurchaseSendType;
             purchaseValueType: PurchaseValueType;
@@ -174,6 +176,20 @@ export declare namespace IMetricsDTO {
         };
     };
 }
+export declare namespace IFunilSummaryDTO {
+    type Params = {
+        workSpaceId: string;
+        startDate?: Date;
+        endDate?: Date;
+        campaigns: string[];
+    };
+    type Result = {
+        data: {
+            type: string;
+            _count: number;
+        }[];
+    };
+}
 export interface IPixelSdk {
     Create(params: ICreatePixelDTO.Params): Promise<ICreatePixelDTO.Result>;
     Update(params: IUpdatePixelDTO.Params): Promise<void>;
@@ -182,5 +198,6 @@ export interface IPixelSdk {
     GetOne(params: IGetOnePixelDTO.Params): Promise<IGetOnePixelDTO.Result>;
     UpdateOffers(params: IUpdateOffersDTO.Params): Promise<void>;
     Metrics(params: IMetricsDTO.Params): Promise<IMetricsDTO.Result>;
+    FunilSummary(params: IFunilSummaryDTO.Params): Promise<IFunilSummaryDTO.Result>;
 }
 export {};

package/dist/index.d.ts

@@ -6,5 +6,5 @@
  */
 export type { AWSConfig, SendSaleParams } from "./config";
 export { PixelSDK } from "./Class";
-export type { InitiateCheckoutDetection, MarketingPlatform, PurchaseEventType, PurchaseSendType, PurchaseValueType, SendIp, Order, } from "./types";
-export { InitiateCheckoutDetectionEnum, PurchaseValueTypeEnum, MarketingPlatformEnum, PurchaseEventTypeEnum, PurchaseSendTypeEnum, SendIpEnum, } from "./types";
+export type { PixelDetection, MarketingPlatform, PurchaseEventType, PurchaseSendType, PurchaseValueType, SendIp, Order, } from "./types";
+export { PixelDetectionEnum, PurchaseValueTypeEnum, MarketingPlatformEnum, PurchaseEventTypeEnum, PurchaseSendTypeEnum, SendIpEnum, } from "./types";

package/dist/index.js

@@ -6,11 +6,11 @@
  * para o micro-serviço de pixels através de uma fila AWS SQS.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SendIpEnum = exports.PurchaseSendTypeEnum = exports.PurchaseEventTypeEnum = exports.MarketingPlatformEnum = exports.PurchaseValueTypeEnum = exports.InitiateCheckoutDetectionEnum = exports.PixelSDK = void 0;
+exports.SendIpEnum = exports.PurchaseSendTypeEnum = exports.PurchaseEventTypeEnum = exports.MarketingPlatformEnum = exports.PurchaseValueTypeEnum = exports.PixelDetectionEnum = exports.PixelSDK = void 0;
 var Class_1 = require("./Class");
 Object.defineProperty(exports, "PixelSDK", { enumerable: true, get: function () { return Class_1.PixelSDK; } });
 var types_1 = require("./types");
-Object.defineProperty(exports, "InitiateCheckoutDetectionEnum", { enumerable: true, get: function () { return types_1.InitiateCheckoutDetectionEnum; } });
+Object.defineProperty(exports, "PixelDetectionEnum", { enumerable: true, get: function () { return types_1.PixelDetectionEnum; } });
 Object.defineProperty(exports, "PurchaseValueTypeEnum", { enumerable: true, get: function () { return types_1.PurchaseValueTypeEnum; } });
 Object.defineProperty(exports, "MarketingPlatformEnum", { enumerable: true, get: function () { return types_1.MarketingPlatformEnum; } });
 Object.defineProperty(exports, "PurchaseEventTypeEnum", { enumerable: true, get: function () { return types_1.PurchaseEventTypeEnum; } });

package/dist/types.d.ts

@@ -1,10 +1,10 @@
-export type InitiateCheckoutDetection = "AUTOMATIC" | "CLASS" | "ID" | "ATTRIBUTE" | "DATA_ATTRIBUTE" | "TAG" | "URL" | "CUSTOM" | "TEXT";
+export type PixelDetection = "AUTOMATIC" | "CLASS" | "ID" | "ATTRIBUTE" | "DATA_ATTRIBUTE" | "TAG" | "URL" | "CUSTOM" | "TEXT";
 export type PurchaseSendType = "SALES_APPROVED" | "SALES_APPROVED_AND_PENDING";
 export type PurchaseEventType = "PURCHASE_PENDING" | "PURCHASE_COMPLETED";
 export type SendIp = "IPV6_AND_IPV4" | "ONLY_IPV6" | "DONT_SEND";
 export type MarketingPlatform = "GOOGLE" | "META" | "TIKTOK";
 export type PurchaseValueType = "SALE_VALUE" | "COMMISSION";
-export declare const InitiateCheckoutDetectionEnum: Record<InitiateCheckoutDetection, InitiateCheckoutDetection>;
+export declare const PixelDetectionEnum: Record<PixelDetection, PixelDetection>;
 export declare const PurchaseSendTypeEnum: Record<PurchaseSendType, PurchaseSendType>;
 export declare const PurchaseValueTypeEnum: Record<PurchaseValueType, PurchaseValueType>;
 export declare const SendIpEnum: Record<SendIp, SendIp>;

package/dist/types.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PurchaseEventTypeEnum = exports.MarketingPlatformEnum = exports.SendIpEnum = exports.PurchaseValueTypeEnum = exports.PurchaseSendTypeEnum = exports.InitiateCheckoutDetectionEnum = void 0;
-exports.InitiateCheckoutDetectionEnum = {
+exports.PurchaseEventTypeEnum = exports.MarketingPlatformEnum = exports.SendIpEnum = exports.PurchaseValueTypeEnum = exports.PurchaseSendTypeEnum = exports.PixelDetectionEnum = void 0;
+exports.PixelDetectionEnum = {
     AUTOMATIC: "AUTOMATIC",
     CLASS: "CLASS",
     ID: "ID",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agenus-io/pixel-backend-sdk",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "SDK para envio de vendas para fila AWS SQS do micro-serviço de pixels",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",