agrs-sequelize-sdk 1.4.16 → 1.4.18

package/models/Campaign.js

@@ -1,157 +1,163 @@
-module.exports = (sequelize, DataTypes) => {
-  const Campaign = sequelize.define(
-    "Campaign",
-    {
-      CampaignID: {
-        type: DataTypes.STRING,
-        primaryKey: true,
-      },
-      CampaignName: {
-        type: DataTypes.TEXT,
-        allowNull: true,
-      },
-      pixelId: {
-        type: DataTypes.STRING,
-        allowNull: true,
-      },
-      customEventType: {
-        type: DataTypes.STRING,
-        allowNull: false,
-        defaultValue: "PURCHASE",
-      },
-      objective: {
-        type: DataTypes.STRING,
-        allowNull: false,
-        defaultValue: "OUTCOME_SALES",
-      },
-      status: {
-        type: DataTypes.STRING,
-        allowNull: true,
-      },
-      AdAccountID: {
-        type: DataTypes.STRING,
-        allowNull: false,
-        references: {
-          model: "AdAccount",
-          key: "AdAccountID",
-        },
-      },
-      CreatedTime: {
-        type: DataTypes.DATE,
-        allowNull: false,
-      },
-      CampaignDelivery: {
-        type: DataTypes.STRING,
-        allowNull: true,
-      },
-      DailyBudget: {
-        type: DataTypes.INTEGER,
-        allowNull: true,
-      },
-      Draft: {
-        type: DataTypes.BOOLEAN,
-        allowNull: true,
-        defaultValue: false,
-      },
-      publish: {
-        type: DataTypes.BOOLEAN,
-        allowNull: true,
-        defaultValue: true,
-      },
-      UserCreated: {
-        type: DataTypes.STRING,
-        allowNull: true,
-      },
-      special_ad_categories: {
-        type: DataTypes.ARRAY(DataTypes.STRING),
-        allowNull: true,
-      },
-      effectiveStatus: {
-        type: DataTypes.STRING,
-        allowNull: true,
-      },
-      issuesInfo: {
-        type: DataTypes.JSONB,
-        allowNull: true,
-      },
-      waiting: {
-        type: DataTypes.BOOLEAN,
-        defaultValue: false,
-      },
-      policy_status: {
-        type: DataTypes.STRING,
-        allowNull: true,
-        comment: "Facebook policy status: APPROVED, DENIED, PENDING, etc.",
-      },
-      policy_rejection_reason: {
-        type: DataTypes.TEXT,
-        allowNull: true,
-        comment: "Detailed reason for policy rejection",
-      },
-      first_spend_date: {
-        type: DataTypes.DATEONLY,
-        allowNull: true,
-        comment:
-          "First date when campaign had spend > 0 (for accurate days_running calculation)",
-      },
-    },
-    {
-      tableName: "Campaign",
-      indexes: [
-        {
-          fields: ["AdAccountID"], // Index on AdAccountID for faster joins
-        },
-        {
-          fields: ["first_spend_date"], // Index for days_running calculations
-        },
-        {
-          fields: ["CampaignID", "first_spend_date"], // Composite index for performance queries
-        },
-      ],
-    }
-  );
-
-  // Define associations
-  Campaign.associate = (models) => {
-    Campaign.belongsTo(models.AdAccount, { foreignKey: "AdAccountID" });
-    Campaign.hasMany(models.AdSet, { foreignKey: "CampaignID" });
-  };
-
-  // Combined beforeUpdate hook
-  Campaign.addHook("beforeUpdate", async (campaign, options) => {
-    if (campaign.changed("publish")) {
-      if (campaign.previous("publish") === true && campaign.publish === false) {
-        // Save current state to CampaignHistory
-        await sequelize.models.CampaignHistory.create({
-          CampaignID: campaign.CampaignID,
-          DataSnapshot: campaign._previousDataValues, // Store current state as JSON
-        });
-      } else if (
-        campaign.previous("publish") === false &&
-        campaign.publish === true
-      ) {
-        // Delete the latest history entry
-        const latestHistory = await sequelize.models.CampaignHistory.findOne({
-          where: { CampaignID: campaign.CampaignID },
-          order: [["timestamp", "DESC"]], // Get the latest history entry
-        });
-
-        if (latestHistory) {
-          await latestHistory.destroy(); // Delete the latest history entry
-        }
-      }
-    }
-  });
-
-  Campaign.addHook("afterCreate", async (campaign, options) => {
-    if (campaign.publish === false) {
-      // If publish is false on creation, save a snapshot to CampaignHistory
-      await sequelize.models.CampaignHistory.create({
-        CampaignID: campaign.CampaignID,
-        DataSnapshot: campaign.toJSON(), // Save current state
-      });
-    }
-  });
-
-  return Campaign;
-};
+module.exports = (sequelize, DataTypes) => {
+  const Campaign = sequelize.define(
+    "Campaign",
+    {
+      CampaignID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      CampaignName: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+      },
+      pixelId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      customEventType: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "PURCHASE",
+      },
+      objective: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "OUTCOME_SALES",
+      },
+      status: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      AdAccountID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        references: {
+          model: "AdAccount",
+          key: "AdAccountID",
+        },
+      },
+      CreatedTime: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+      CampaignDelivery: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      DailyBudget: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+      Draft: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: false,
+      },
+      publish: {
+        type: DataTypes.BOOLEAN,
+        allowNull: true,
+        defaultValue: true,
+      },
+      UserCreated: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      special_ad_categories: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: true,
+      },
+      effectiveStatus: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      issuesInfo: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      waiting: {
+        type: DataTypes.BOOLEAN,
+        defaultValue: false,
+      },
+      policy_status: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "Facebook policy status: APPROVED, DENIED, PENDING, etc.",
+      },
+      policy_rejection_reason: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+        comment: "Detailed reason for policy rejection",
+      },
+      first_spend_date: {
+        type: DataTypes.DATEONLY,
+        allowNull: true,
+        comment:
+          "First date when campaign had spend > 0 (for accurate days_running calculation)",
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+    },
+    {
+      tableName: "Campaign",
+      indexes: [
+        {
+          fields: ["AdAccountID"], // Index on AdAccountID for faster joins
+        },
+        {
+          fields: ["first_spend_date"], // Index for days_running calculations
+        },
+        {
+          fields: ["CampaignID", "first_spend_date"], // Composite index for performance queries
+        },
+      ],
+    }
+  );
+
+  // Define associations
+  Campaign.associate = (models) => {
+    Campaign.belongsTo(models.AdAccount, { foreignKey: "AdAccountID" });
+    Campaign.hasMany(models.AdSet, { foreignKey: "CampaignID" });
+  };
+
+  // Combined beforeUpdate hook
+  Campaign.addHook("beforeUpdate", async (campaign, options) => {
+    if (campaign.changed("publish")) {
+      if (campaign.previous("publish") === true && campaign.publish === false) {
+        // Save current state to CampaignHistory
+        await sequelize.models.CampaignHistory.create({
+          CampaignID: campaign.CampaignID,
+          DataSnapshot: campaign._previousDataValues, // Store current state as JSON
+        });
+      } else if (
+        campaign.previous("publish") === false &&
+        campaign.publish === true
+      ) {
+        // Delete the latest history entry
+        const latestHistory = await sequelize.models.CampaignHistory.findOne({
+          where: { CampaignID: campaign.CampaignID },
+          order: [["timestamp", "DESC"]], // Get the latest history entry
+        });
+
+        if (latestHistory) {
+          await latestHistory.destroy(); // Delete the latest history entry
+        }
+      }
+    }
+  });
+
+  Campaign.addHook("afterCreate", async (campaign, options) => {
+    if (campaign.publish === false) {
+      // If publish is false on creation, save a snapshot to CampaignHistory
+      await sequelize.models.CampaignHistory.create({
+        CampaignID: campaign.CampaignID,
+        DataSnapshot: campaign.toJSON(), // Save current state
+      });
+    }
+  });
+
+  return Campaign;
+};

package/models/CampaignActionHistory.js

@@ -1,86 +1,86 @@
-module.exports = (sequelize, DataTypes) => {
-  const CampaignActionHistory = sequelize.define(
-    "CampaignActionHistory",
-    {
-      id: {
-        type: DataTypes.UUID,
-        defaultValue: DataTypes.UUIDV4,
-        primaryKey: true,
-      },
-      objectId: {
-        type: DataTypes.STRING,
-        allowNull: false,
-        comment:
-          "ID of the object being tracked (campaignId, AGRSCID, adsetId, etc.)",
-        index: true,
-      },
-      objectType: {
-        type: DataTypes.ENUM("campaign", "agrscid", "adset", "ad"),
-        allowNull: false,
-        comment: "Type of object to know what objectId represents",
-        index: true,
-      },
-      actionType: {
-        type: DataTypes.STRING,
-        allowNull: false,
-        comment:
-          "Type of action: budget_update, bid_update, keyword_update, duplicated, etc.",
-        index: true,
-      },
-      previousValue: {
-        type: DataTypes.JSON,
-        allowNull: true,
-        comment: "Previous value before the action",
-      },
-      newValue: {
-        type: DataTypes.JSON,
-        allowNull: true,
-        comment: "New value after the action",
-      },
-      details: {
-        type: DataTypes.JSON,
-        allowNull: true,
-        comment: "Additional context and metadata about the action",
-      },
-      userId: {
-        type: DataTypes.STRING,
-        allowNull: true,
-        comment: "ID of the user who performed the action",
-      },
-      createdAt: {
-        type: DataTypes.DATE,
-        defaultValue: DataTypes.NOW,
-        allowNull: false,
-        index: true,
-      },
-      updatedAt: {
-        type: DataTypes.DATE,
-        defaultValue: DataTypes.NOW,
-      },
-    },
-    {
-      tableName: "CampaignActionHistories",
-      timestamps: true,
-      indexes: [
-        {
-          fields: ["objectId", "objectType"],
-          name: "idx_object_id_type",
-        },
-        {
-          fields: ["actionType"],
-          name: "idx_action_type",
-        },
-        {
-          fields: ["createdAt"],
-          name: "idx_created_at",
-        },
-        {
-          fields: ["objectId", "actionType"],
-          name: "idx_object_action",
-        },
-      ],
-    }
-  );
-
-  return CampaignActionHistory;
-};
+module.exports = (sequelize, DataTypes) => {
+  const CampaignActionHistory = sequelize.define(
+    "CampaignActionHistory",
+    {
+      id: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      objectId: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        comment:
+          "ID of the object being tracked (campaignId, AGRSCID, adsetId, etc.)",
+        index: true,
+      },
+      objectType: {
+        type: DataTypes.ENUM("campaign", "agrscid", "adset", "ad"),
+        allowNull: false,
+        comment: "Type of object to know what objectId represents",
+        index: true,
+      },
+      actionType: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        comment:
+          "Type of action: budget_update, bid_update, keyword_update, duplicated, etc.",
+        index: true,
+      },
+      previousValue: {
+        type: DataTypes.JSON,
+        allowNull: true,
+        comment: "Previous value before the action",
+      },
+      newValue: {
+        type: DataTypes.JSON,
+        allowNull: true,
+        comment: "New value after the action",
+      },
+      details: {
+        type: DataTypes.JSON,
+        allowNull: true,
+        comment: "Additional context and metadata about the action",
+      },
+      userId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        comment: "ID of the user who performed the action",
+      },
+      createdAt: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+        allowNull: false,
+        index: true,
+      },
+      updatedAt: {
+        type: DataTypes.DATE,
+        defaultValue: DataTypes.NOW,
+      },
+    },
+    {
+      tableName: "CampaignActionHistories",
+      timestamps: true,
+      indexes: [
+        {
+          fields: ["objectId", "objectType"],
+          name: "idx_object_id_type",
+        },
+        {
+          fields: ["actionType"],
+          name: "idx_action_type",
+        },
+        {
+          fields: ["createdAt"],
+          name: "idx_created_at",
+        },
+        {
+          fields: ["objectId", "actionType"],
+          name: "idx_object_action",
+        },
+      ],
+    }
+  );
+
+  return CampaignActionHistory;
+};