agrs-sequelize-sdk 1.4.18 → 1.4.21

package/.worktrees/tt-snp-adset-ad-tables/models/ActivityHistory.js

@@ -0,0 +1,73 @@
+// models/ActivityHistory.js
+module.exports = (sequelize, DataTypes) => {
+  const ActivityHistory = sequelize.define(
+    "ActivityHistory",
+    {
+      ActivityHistoryID: {
+        type: DataTypes.INTEGER,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      AssociatedModelType: {
+        type: DataTypes.STRING,
+        allowNull: false, // Could be 'Ad', 'AdSet', 'Campaign', etc.
+      },
+      AssociatedModelID: {
+        type: DataTypes.STRING,
+        allowNull: false, // ID of the associated model
+      },
+      ActorID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ActorName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ApplicationName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      DateTimeInTimeZone: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      EventType: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ObjectName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ObjectType: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      TranslatedEventType: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ObjectID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      ExtraData: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "ActivityHistory",
+      indexes: [
+        {
+          unique: true,
+          name: "unique_index_on_date_object_event", // Custom name
+          fields: ["DateTimeInTimeZone", "ObjectID", "EventType"],
+        },
+      ],
+    }
+  );
+
+  return ActivityHistory;
+};

package/.worktrees/tt-snp-adset-ad-tables/models/Ad.js

@@ -0,0 +1,300 @@
+module.exports = (sequelize, DataTypes) => {
+  const Ad = sequelize.define(
+    "Ad",
+    {
+      AdID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AdName: {
+        type: DataTypes.TEXT,
+        allowNull: false,
+      },
+      AdSetID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        references: {
+          model: "AdSet",
+          key: "AdSetID",
+        },
+      },
+      creativeId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        // references: {
+        //   model: "AdCreatives", // Assuming you have an AdCreative model
+        //   key: "id",
+        // },
+      },
+      pixelId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      startTime: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      endTime: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      format: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "SINGLE",
+      },
+      imageHashes: {
+        type: DataTypes.ARRAY(DataTypes.STRING), // Array of image hashes
+        allowNull: true,
+      },
+      videoIds: {
+        type: DataTypes.ARRAY(DataTypes.STRING), // Array of video IDs
+        allowNull: true,
+      },
+      messages: {
+        type: DataTypes.ARRAY(DataTypes.TEXT), // Array of primary text messages
+        allowNull: true,
+      },
+      headlines: {
+        type: DataTypes.ARRAY(DataTypes.TEXT), // Array of headlines
+        allowNull: true,
+      },
+      websiteUrl: {
+        type: DataTypes.TEXT, // Increase limit for longer URLs
+        allowNull: true,
+      },
+      pageId: {
+        type: DataTypes.STRING(256), // Increase limit for longer URLs
+        allowNull: true,
+      },
+      actionTypes: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        defaultValue: "offsite_conversion",
+      },
+      Status: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      publish: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: true,
+      },
+      createdTime: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      AGRS_CID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      Draft: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: false,
+      },
+      UserCreated: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      // add effective_status field
+      effectiveStatus: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      // add issues_info field
+      issuesInfo: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      // add ad_review_feedback
+      adReviewFeedback: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      policy_status: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "Policy review status: approved, disapproved, pending, etc."
+      },
+      policy_rejection_reason: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        comment: "Detailed reason for policy rejection from Predicto"
+      },
+      dogs_processed: {
+        type: DataTypes.BOOLEAN,
+        defaultValue: false,
+        allowNull: true,
+        comment: "Whether this ad has been processed by the rejected-ad dogs replacement job",
+      },
+      waiting: {
+        type: DataTypes.BOOLEAN,
+        defaultValue: false,
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      tableName: "Ad",
+      indexes: [
+        {
+          fields: ["AdSetID"], // Index on AdSetID for faster join
+        },
+        {
+          name: "idx_ad_policy_agrs_cid_status",
+          fields: ["AGRS_CID", "policy_status"],
+          comment: "Critical index for policy filtering queries"
+        },
+      ],
+    }
+  );
+
+  // Ad.associate = (models) => {
+  //   Ad.belongsTo(models.AdSet, { foreignKey: "AdSetID" });
+
+  //   // Association with CodefuelCampaign using AGRS_CID
+  //   Ad.belongsTo(models.CodefuelCampaign, {
+  //     foreignKey: "AGRS_CID",
+  //     targetKey: "AGRSCID",
+  //     as: "CodefuelCampaign",
+  //     constraints: false, // Disable FK constraint at the DB level
+  //   });
+
+  //   Ad.hasMany(models.AdPerformance, {
+  //     foreignKey: "AdID",
+  //   });
+  // };
+
+  Ad.associate = (models) => {
+    Ad.belongsTo(models.AdSet, { foreignKey: "AdSetID" });
+
+    // Add dynamic relations to either CodefuelCampaign or RSOCFeedCampaign
+    Ad.belongsTo(models.CodefuelCampaign, {
+      foreignKey: "AGRS_CID",
+      targetKey: "AGRSCID",
+      as: "CodefuelCampaign",
+      constraints: false, // Disable FK constraint
+    });
+
+    Ad.belongsTo(models.RSOCFeedCampaign, {
+      foreignKey: "AGRS_CID",
+      targetKey: "AGRS_CID",
+      as: "RSOCFeedCampaign",
+      constraints: false, // Disable FK constraint
+    });
+
+    Ad.hasMany(models.AdPerformance, {
+      foreignKey: "AdID",
+    });
+  };
+
+  // // Method to dynamically fetch related campaign
+  // Ad.prototype.getRelatedCampaign = async function () {
+  //   if (!this.AGRS_CID) return null;
+
+  //   const codefuelCampaign = await sequelize.models.CodefuelCampaign.findOne({
+  //     where: { AGRSCID: this.AGRS_CID },
+  //   });
+
+  //   if (codefuelCampaign) {
+  //     return {
+  //       type: "CodefuelCampaign",
+  //       data: codefuelCampaign,
+  //     };
+  //   }
+
+  //   const tonicCampaign = await sequelize.models.TonicCampaign.findOne({
+  //     where: { AGRSCID: this.AGRS_CID },
+  //   });
+
+  //   if (tonicCampaign) {
+  //     return {
+  //       type: "TonicCampaign",
+  //       data: tonicCampaign,
+  //     };
+  //   }
+
+  //   // do the same with RSOCFeedCampaign
+  //   const rsocFeedCampaign = await sequelize.models.RSOCFeedCampaign.findOne({
+  //     where: { AGRS_CID: this.AGRS_CID },
+  //   });
+
+  //   if (rsocFeedCampaign) {
+  //     return {
+  //       type: "RSOCFeedCampaign",
+  //       data: rsocFeedCampaign,
+  //     };
+  //   }
+  //   return null;
+  // };
+
+  Ad.prototype.getRelatedCampaign = async function () {
+    if (!this.AGRS_CID) return null;
+
+    // Try fetching related CodefuelCampaign
+    const codefuelCampaign = await sequelize.models.CodefuelCampaign.findOne({
+      where: { AGRSCID: this.AGRS_CID },
+    });
+
+    if (codefuelCampaign) {
+      return {
+        type: "CodefuelCampaign",
+        data: codefuelCampaign,
+      };
+    }
+
+    // Try fetching related RSOCFeedCampaign
+    const rsocFeedCampaign = await sequelize.models.RSOCFeedCampaign.findOne({
+      where: { AGRS_CID: this.AGRS_CID },
+    });
+
+    if (rsocFeedCampaign) {
+      return {
+        type: "RSOCFeedCampaign",
+        data: rsocFeedCampaign,
+      };
+    }
+
+    return null;
+  };
+
+  Ad.addHook("afterCreate", async (ad, options) => {
+    if (ad.publish === false) {
+      // If publish is false on creation, save a snapshot to AdHistory
+      await sequelize.models.AdHistory.create({
+        AdID: ad.AdID,
+        DataSnapshot: ad.toJSON(), // Save the full Ad data as JSON
+      });
+    }
+  });
+
+  Ad.addHook("beforeUpdate", async (ad, options) => {
+    if (ad.changed("publish")) {
+      if (ad.previous("publish") === true && ad.publish === false) {
+        // Save current state to AdHistory
+        await sequelize.models.AdHistory.create({
+          AdID: ad.AdID,
+          DataSnapshot: ad._previousDataValues, // Save the full Ad data as JSON
+        });
+      } else if (ad.previous("publish") === false && ad.publish === true) {
+        // Delete the latest history entry
+        const latestHistory = await sequelize.models.AdHistory.findOne({
+          where: { AdID: ad.AdID },
+          order: [["timestamp", "DESC"]], // Get the latest history entry
+        });
+
+        if (latestHistory) {
+          await latestHistory.destroy();
+        }
+      }
+    }
+  });
+
+  return Ad;
+};

package/.worktrees/tt-snp-adset-ad-tables/models/AdAccount.js

@@ -0,0 +1,97 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdAccount = sequelize.define(
+    "AdAccount",
+    {
+      AdAccountID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AdAccountName: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      AdAccountTimeZone: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      Currency: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      Rate: {
+        type: DataTypes.FLOAT,
+        allowNull: false,
+      },
+      UTCOffset: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+      },
+      Draft: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+      },
+      account_status: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      // includeInUpdate: bool
+      IncludeInUpdate: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+      },
+      BusinessManager: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      Reporting: {
+        type: DataTypes.BOOLEAN,
+        defaultValue: true,
+        allowNull: true,
+      },
+      Users: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: false,
+        defaultValue: [],
+      },
+      feedProvider: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: false,
+        defaultValue: [], // Default value is an empty array
+      },
+      Archived: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+      },
+      disabled_reason: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      tableName: "AdAccount",
+      indexes: [
+        {
+          fields: ["AdAccountName"],
+        },
+        {
+          fields: ["Currency"],
+        },
+      ],
+    }
+  );
+
+  AdAccount.associate = (models) => {
+    AdAccount.hasMany(models.Campaign, {
+      foreignKey: "AdAccountID",
+      as: "Campaigns",
+    });
+  };
+
+  return AdAccount;
+};

package/.worktrees/tt-snp-adset-ad-tables/models/AdAccountValues.js

@@ -0,0 +1,26 @@
+module.exports = (sequelize, DataTypes) => {
+    const AdAccountValues = sequelize.define(
+      "AdAccountValues",
+      {
+        id: {
+          type: DataTypes.UUID,
+          defaultValue: DataTypes.UUIDV4,
+          primaryKey: true,
+        },
+        name: {
+          type: DataTypes.STRING,
+          allowNull: false,
+        },
+        code: {
+          type: DataTypes.STRING,
+          allowNull: false,
+          unique: true, 
+        },
+      },
+      {
+        tableName: "AdAccountValues",
+      }
+    );
+  
+    return AdAccountValues;
+  };

package/.worktrees/tt-snp-adset-ad-tables/models/AdHistory.js

@@ -0,0 +1,30 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdHistory = sequelize.define(
+    "AdHistory",
+    {
+      HistoryID: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      AdID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      DataSnapshot: {
+        type: DataTypes.JSONB, // Store the full Ad row as a JSON object
+        allowNull: false,
+      },
+      timestamp: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+    },
+    {
+      tableName: "AdHistory",
+      timestamps: false, // Disable Sequelize timestamps
+    }
+  );
+
+  return AdHistory;
+};

package/.worktrees/tt-snp-adset-ad-tables/models/AdPerformance.js

@@ -0,0 +1,100 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdPerformance = sequelize.define(
+    "AdPerformance",
+    {
+      Date: {
+        type: DataTypes.DATEONLY,
+        primaryKey: true,
+      },
+      AdID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        primaryKey: true,
+      },
+      AmountSpent: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      Impressions: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      LinkClicks: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Revenue: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      AdClicks: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Sessions: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      ViewContent: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Search: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Purchase: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Lead: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      originalSpend: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      PurchasesConversionValue: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+
+      originRevenue: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      tableName: "AdPerformance",
+      indexes: [
+        {
+          unique: true,
+          fields: ["AdID", "Date"], // Composite unique index
+        },
+        {
+          fields: ["Date"], // Index on Date for faster range queries
+        },
+        {
+          fields: ["AdID"], // Index on AdID for faster join
+        },
+      ],
+    }
+  );
+
+  AdPerformance.associate = (models) => {
+    AdPerformance.belongsTo(models.Ad, { foreignKey: "AdID" });
+  };
+
+  return AdPerformance;
+};

package/.worktrees/tt-snp-adset-ad-tables/models/AdPerformanceHourly.js

@@ -0,0 +1,71 @@
+// models/AdPerformanceHourly.js
+module.exports = (sequelize, DataTypes) => {
+  const AdPerformanceHourly = sequelize.define(
+    "AdPerformanceHourly",
+    {
+      Date: {
+        type: DataTypes.DATEONLY,
+        primaryKey: true,
+      },
+      Hour: {
+        type: DataTypes.INTEGER,
+        primaryKey: true,
+      },
+      AdID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      AmountSpent: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+      Impressions: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      LinkClicks: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      ViewContent: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Search: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Purchase: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Lead: {
+        // New field
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      originalSpend: {
+        type: DataTypes.FLOAT,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "AdPerformanceHourly",
+      indexes: [
+        {
+          unique: true,
+          fields: ["AdID", "Date", "Hour"],
+        },
+      ],
+    }
+  );
+
+  AdPerformanceHourly.associate = (models) => {
+    AdPerformanceHourly.belongsTo(models.Ad, { foreignKey: "AdID" });
+  };
+
+  return AdPerformanceHourly;
+};