agrs-sequelize-sdk 1.0.0

package/models/Campaign.js

@@ -0,0 +1,112 @@
+// module.exports = (sequelize, DataTypes) => {
+//   const Campaign = sequelize.define(
+//     "Campaign",
+//     {
+//       CampaignID: {
+//         type: DataTypes.STRING,
+//         primaryKey: true,
+//       },
+//       CampaignName: {
+//         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: false,
+//       },
+//     },
+//     {
+//       tableName: "Campaign",
+//     }
+//   );
+
+//   Campaign.associate = (models) => {
+//     Campaign.belongsTo(models.AdAccount, { foreignKey: "AdAccountID" });
+//     Campaign.hasMany(models.AdSet, { foreignKey: "CampaignID" }); // Association to AdSet
+//   };
+
+//   return Campaign;
+// };
+
+module.exports = (sequelize, DataTypes) => {
+  const Campaign = sequelize.define(
+    "Campaign",
+    {
+      CampaignID: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+
+      CampaignName: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      pixelId: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      customEventType: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "PURCHASE", // Default value is 'PURCHASE'
+      },
+      objective: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        defaultValue: "OUTCOME_SALES", // Default value is '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: false,
+      },
+      DailyBudget: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "Campaign",
+      indexes: [
+        {
+          fields: ["AdAccountID"], // Index on AdAccountID for faster join
+        },
+      ],
+    }
+  );
+
+  Campaign.associate = (models) => {
+    Campaign.belongsTo(models.AdAccount, { foreignKey: "AdAccountID" });
+    Campaign.hasMany(models.AdSet, { foreignKey: "CampaignID" });
+  };
+
+  return Campaign;
+};

package/models/CodefuelCampaign.js

@@ -0,0 +1,112 @@
+const { DataTypes } = require("sequelize");
+module.exports = (sequelize, DataTypes) => {
+  const CodefuelCampaign = sequelize.define("CodefuelCampaign", {
+    AGRSCID: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      unique: true,
+      primaryKey: true,
+    },
+    Assignee: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    Status: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    Country: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    Vertical: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    FreeText: {
+      type: DataTypes.TEXT,
+      allowNull: true,
+    },
+    CampaignName: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    CampaignID: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    KW: {
+      type: DataTypes.ARRAY(DataTypes.STRING),
+      allowNull: true,
+    },
+    FinalLink: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    PixelID: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    Token: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    AccountID: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    FeedName: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    AdTitle: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Domain: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    feedProvider: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      defaultValue: "CodeFuel",
+    },
+    lastUpdateKw: {
+      type: DataTypes.DATE,
+      allowNull: true,
+    },
+    createdCampaignAt: {
+      type: DataTypes.DATE,
+      allowNull: true, // Ensure this is allowed to be null if necessary
+    },
+  });
+  CodefuelCampaign.associate = (models) => {
+    CodefuelCampaign.hasMany(models.Ad, {
+      foreignKey: "AGRS_CID",
+      sourceKey: "AGRSCID",
+      as: "Ads",
+      constraints: false,
+    });
+  };
+  // Hook to save the previous KW version to history before updating
+  CodefuelCampaign.beforeUpdate(async (campaign, options) => {
+    if (campaign.changed("KW")) {
+      const previousKW = campaign.previous("KW");
+      const currentHistory =
+        await sequelize.models.CodefuelCampaignKWHistory.findAll({
+          where: { campaignId: campaign.AGRSCID },
+          order: [["version", "DESC"]],
+        });
+      const nextVersion = currentHistory.length
+        ? currentHistory[0].version + 1
+        : 1;
+      await sequelize.models.CodefuelCampaignKWHistory.create({
+        campaignId: campaign.AGRSCID,
+        kw: previousKW,
+        version: nextVersion,
+      });
+    }
+  });
+  return CodefuelCampaign;
+};

package/models/CodefuelCampaignKWHistory.js

@@ -0,0 +1,41 @@
+const { DataTypes } = require("sequelize");
+
+module.exports = (sequelize, DataTypes) => {
+  const CodefuelCampaignKWHistory = sequelize.define(
+    "CodefuelCampaignKWHistory",
+    {
+      id: {
+        type: DataTypes.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+      },
+      campaignId: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      kw: {
+        type: DataTypes.ARRAY(DataTypes.STRING),
+        allowNull: false,
+      },
+      version: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+      },
+      createdAt: {
+        type: DataTypes.DATE,
+        allowNull: false,
+        defaultValue: DataTypes.NOW,
+      },
+    }
+  );
+
+  CodefuelCampaignKWHistory.associate = (models) => {
+    CodefuelCampaignKWHistory.belongsTo(models.CodefuelCampaign, {
+      foreignKey: "campaignId",
+      targetKey: "AGRSCID",
+      onDelete: "CASCADE",
+    });
+  };
+
+  return CodefuelCampaignKWHistory;
+};

package/models/CodefuelKeywords.js

@@ -0,0 +1,35 @@
+// CodefuelKeywords.js
+
+module.exports = (sequelize, DataTypes) => {
+  const CodefuelKeywords = sequelize.define("CodefuelKeywords", {
+    id: {
+      type: DataTypes.INTEGER,
+      autoIncrement: true,
+      primaryKey: true,
+    },
+    campaignId: {
+      type: DataTypes.STRING,
+      references: {
+        model: "CodefuelCampaigns",
+        key: "AGRSCID",
+      },
+      onDelete: "CASCADE",
+    },
+    keywords: {
+      type: DataTypes.ARRAY(DataTypes.STRING),
+      allowNull: true,
+    },
+  });
+
+  CodefuelKeywords.associate = (models) => {
+    CodefuelKeywords.belongsTo(models.CodefuelCampaign, {
+      foreignKey: "campaignId",
+      onDelete: "CASCADE",
+    });
+  };
+
+  // Ensure Paper Trail is initialized here
+  //   CodefuelKeywords.hasPaperTrail();
+
+  return CodefuelKeywords;
+};

package/models/CurrencyRate.js

@@ -0,0 +1,27 @@
+const { DataTypes } = require("sequelize");
+
+module.exports = (sequelize) => {
+  const CurrencyRate = sequelize.define("CurrencyRate", {
+    id: {
+      type: DataTypes.UUID,
+      defaultValue: DataTypes.UUIDV4,
+      primaryKey: true,
+    },
+    currency: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      defaultValue: "ARS",
+    },
+    rate: {
+      type: DataTypes.FLOAT,
+      allowNull: false,
+    },
+    date: {
+      type: DataTypes.DATEONLY,
+      allowNull: false,
+      defaultValue: DataTypes.NOW,
+    },
+  });
+
+  return CurrencyRate;
+};

package/models/Files.js

@@ -0,0 +1,64 @@
+
+module.exports = (sequelize, DataTypes) => {
+  const Files = sequelize.define("Files", {
+    id: {
+      type: DataTypes.STRING,
+      primaryKey: true,
+    },
+    name: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    type: {
+      type: DataTypes.STRING, // Can be "image" or "video"
+      allowNull: false,
+    },
+    adAccountId: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    URL: {
+      type: DataTypes.STRING, // URL for the file
+      allowNull: false,
+    },
+    ParentFolder: {
+      type: DataTypes.STRING, // Folder ID for the parent folder
+      allowNull: true, // This allows the file to exist without a folder
+    },
+    ParentFolders: {
+      type: DataTypes.ARRAY(DataTypes.STRING),
+      allowNull: true,
+    },
+    FileType: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      defaultValue: "txt",
+    },
+    Size: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Language: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Vertical: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+  });
+
+  Files.associate = function (models) {
+    // Optional relationship: Each file may belong to a folder (ParentFolder), but it can be null
+    /*Files.belongsTo(models.Folders, {
+      foreignKey: "ParentFolders",
+      targetKey: "id",
+      allowNull: true,
+    });*/
+
+    // Each file belongs to an AdCreative (assuming this is a separate model)
+    Files.belongsTo(models.AdCreative, { foreignKey: "id", targetKey: "id" });
+  };
+
+  return Files;
+};

package/models/Folders.js

@@ -0,0 +1,37 @@
+module.exports = (sequelize, DataTypes) => {
+    const Folders = sequelize.define("Folders", {
+      id: {
+        type: DataTypes.STRING,
+        primaryKey: true,
+      },
+      ParentFolder: {
+        type: DataTypes.STRING, // Self-referencing folder ID
+        allowNull: true,
+      },
+      ParentFolders: {
+        type: DataTypes.ARRAY(DataTypes.STRING), // Array of folder IDs
+        allowNull: true,
+      },
+      name: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      FilesCount: {
+        type: DataTypes.INTEGER,
+        allowNull: true,
+        defaultValue: 0,
+      }
+    });
+  
+    Folders.associate = function (models) {
+      // One-to-many: A folder can have many files
+      Folders.hasMany(models.Files, { foreignKey: "ParentFolder", sourceKey: "id" });
+  
+      // Self-referencing: A folder can have subfolders
+      Folders.hasMany(models.Folders, { foreignKey: "ParentFolder", sourceKey: "id" });
+      Folders.belongsTo(models.Folders, { foreignKey: "ParentFolder", targetKey: "id" });
+    };
+  
+    return Folders;
+  };
+  

package/models/KeywordPerformance.js

@@ -0,0 +1,65 @@
+module.exports = (sequelize, DataTypes) => {
+  const KeywordPerformance = sequelize.define(
+    "KeywordPerformance",
+    {
+      Date: {
+        type: DataTypes.DATEONLY,
+        primaryKey: true,
+      },
+      adID: {
+        type: DataTypes.STRING,
+        references: {
+          model: "Ad",
+          key: "AdID",
+        },
+        foreignKey: true,
+        primaryKey: true,
+      },
+      Keyword: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        primaryKey: true,
+      },
+      Revenue: {
+        type: DataTypes.FLOAT,
+        allowNull: false,
+      },
+      Clicks: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+      },
+    },
+    {
+      tableName: "KeywordPerformance",
+      indexes: [
+        {
+          unique: true,
+          fields: ["adID", "Date", "Keyword"], // Composite unique index for fast lookups
+        },
+        {
+          fields: ["Date"], // Index for date filtering
+        },
+        {
+          fields: ["adID"], // Index for faster joins on adID
+        },
+        {
+          fields: ["Keyword"], // Index for faster searches on Keyword
+        },
+        {
+          fields: ["Revenue"], // Index to optimize sorting/filtering on Revenue
+        },
+        {
+          fields: ["Clicks"], // Index to optimize sorting/filtering on Clicks
+        },
+      ],
+    }
+  );
+
+  KeywordPerformance.associate = (models) => {
+    KeywordPerformance.belongsTo(models.Ad, {
+      foreignKey: "adID",
+    });
+  };
+
+  return KeywordPerformance;
+};

package/models/KeywordRotationState.js

@@ -0,0 +1,46 @@
+// models/KeywordRotationState.js
+const { DataTypes } = require("sequelize");
+
+module.exports = (sequelize) => {
+  const KeywordRotationState = sequelize.define("KeywordRotationState", {
+    campaignId: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      primaryKey: true,
+    },
+    staticKeywords: {
+      type: DataTypes.ARRAY(DataTypes.STRING),
+      allowNull: false,
+      defaultValue: [], // Default to empty array if no static keywords are provided
+    },
+    rotatingKeywords: {
+      type: DataTypes.ARRAY(DataTypes.STRING),
+      allowNull: false,
+      defaultValue: [], // Default to empty array if no rotating keywords are provided
+    },
+    offset: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+      defaultValue: 0,
+    },
+    rotationTime: {
+      type: DataTypes.INTEGER, // in minutes
+      allowNull: false,
+    },
+    rotatingKeywordSlots: {
+      type: DataTypes.INTEGER, // Number of keyword slots assigned to rotation
+      allowNull: false,
+    },
+    lastRotationTime: {
+      type: DataTypes.DATE,
+      allowNull: true,
+    },
+    status: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      defaultValue: "Not Set", // Default to started when first created
+    },
+  });
+
+  return KeywordRotationState;
+};

package/models/Rule.js

@@ -0,0 +1,39 @@
+module.exports = (sequelize, DataTypes) => {
+  const Rule = sequelize.define("Rule", {
+    ruleName: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    timeUnit: {
+      type: DataTypes.ENUM("minutes", "hours", "days"),
+      allowNull: false,
+    },
+    timeValue: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+    },
+    daysAndTimes: {
+      type: DataTypes.JSONB, // Store days, time ranges, and conditions as a JSON object
+      allowNull: true,
+    },
+    filters: {
+      type: DataTypes.JSONB,
+      allowNull: true,
+    },
+    triggers: {
+      type: DataTypes.JSONB,
+      allowNull: false,
+    },
+    actions: {
+      type: DataTypes.JSONB,
+      allowNull: false,
+    },
+    status: {
+      type: DataTypes.ENUM("active", "paused"),
+      allowNull: false,
+      defaultValue: "active",
+    },
+  });
+
+  return Rule;
+};

package/models/TonicCampaign.js

@@ -0,0 +1,97 @@
+const { DataTypes } = require("sequelize");
+
+module.exports = (sequelize, DataTypes) => {
+  const TonicCampaign = sequelize.define("TonicCampaign", {
+    AGRSCID: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      unique: true,
+      primaryKey: true,
+    },
+    CampaignName: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    CampaignID: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Vertical: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Offer: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    OfferID: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Country: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    Domain: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Imprint: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      defaultValue: "no",
+    },
+    Status: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      defaultValue: "inactive",
+    },
+    FinalLink: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    Assignee: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    KW: {
+      type: DataTypes.ARRAY(DataTypes.STRING),
+      allowNull: true,
+    },
+    PixelID: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    Token: {
+      type: DataTypes.STRING(1024),
+      allowNull: true,
+    },
+    AccountID: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+    FeedName: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    AdTitle: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+    Target: {
+      type: DataTypes.STRING,
+      allowNull: true,
+    },
+  });
+
+  TonicCampaign.associate = (models) => {
+    TonicCampaign.hasMany(models.Ad, {
+      foreignKey: "AGRS_CID",
+      sourceKey: "AGRSCID",
+      constraints: false, // Disable the strict foreign key constraint
+      as: "Ads",
+    });
+  };
+
+  return TonicCampaign;
+};