agrs-sequelize-sdk 1.4.18 → 1.4.21

package/models/ApiAuditLog.js

@@ -0,0 +1,84 @@
+module.exports = (sequelize, DataTypes) => {
+  const ApiAuditLog = sequelize.define(
+    "ApiAuditLog",
+    {
+      id: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      user_id: {
+        type: DataTypes.UUID,
+        allowNull: false,
+        references: {
+          model: "Users",
+          key: "id",
+        },
+      },
+      token_id: {
+        type: DataTypes.UUID,
+        allowNull: true,
+        references: {
+          model: "ApiToken",
+          key: "id",
+        },
+      },
+      ts: {
+        type: DataTypes.DATE,
+        allowNull: false,
+        defaultValue: DataTypes.NOW,
+      },
+      method: {
+        type: DataTypes.STRING(10),
+        allowNull: false,
+      },
+      path: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      status_code: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+      },
+      ip: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      resource_type: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      resource_id: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      payload_diff: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      dry_run: {
+        type: DataTypes.BOOLEAN,
+        allowNull: false,
+        defaultValue: false,
+      },
+    },
+    {
+      tableName: "ApiAuditLog",
+      indexes: [
+        { fields: [{ name: "user_id" }, { name: "ts", order: "DESC" }] },
+        { fields: [{ name: "token_id" }, { name: "ts", order: "DESC" }] },
+        { fields: ["resource_type", "resource_id"] },
+      ],
+    }
+  );
+
+  ApiAuditLog.associate = (models) => {
+    ApiAuditLog.belongsTo(models.Users, { foreignKey: "user_id", as: "user" });
+    ApiAuditLog.belongsTo(models.ApiToken, {
+      foreignKey: "token_id",
+      as: "token",
+    });
+  };
+
+  return ApiAuditLog;
+};

package/models/ApiToken.js

@@ -0,0 +1,67 @@
+module.exports = (sequelize, DataTypes) => {
+  const ApiToken = sequelize.define(
+    "ApiToken",
+    {
+      id: {
+        type: DataTypes.UUID,
+        defaultValue: DataTypes.UUIDV4,
+        primaryKey: true,
+      },
+      user_id: {
+        type: DataTypes.UUID,
+        allowNull: false,
+        references: {
+          model: "Users",
+          key: "id",
+        },
+      },
+      token_hash: {
+        type: DataTypes.STRING(64),
+        allowNull: false,
+        unique: true,
+      },
+      prefix: {
+        type: DataTypes.STRING(16),
+        allowNull: false,
+      },
+      scopes: {
+        type: DataTypes.JSONB,
+        allowNull: false,
+        defaultValue: ["read"],
+      },
+      expires_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+      last_used_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      last_used_ip: {
+        type: DataTypes.STRING,
+        allowNull: true,
+      },
+      revoked_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "ApiToken",
+      indexes: [
+        { unique: true, fields: ["token_hash"] },
+        { fields: ["user_id", "revoked_at"] },
+      ],
+    }
+  );
+
+  ApiToken.associate = (models) => {
+    ApiToken.belongsTo(models.Users, { foreignKey: "user_id", as: "user" });
+    ApiToken.hasMany(models.ApiAuditLog, {
+      foreignKey: "token_id",
+      as: "auditLogs",
+    });
+  };
+
+  return ApiToken;
+};

package/models/CampaignCreationLog.js

@@ -114,6 +114,13 @@ module.exports = (sequelize, DataTypes) => {
         allowNull: true,
         comment: "Platform (e.g., Facebook)",
       },
+      platform_code: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment:
+          "Canonical ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
       bid_strategy: {
         type: DataTypes.STRING(100),
         allowNull: true,
@@ -262,6 +269,11 @@ module.exports = (sequelize, DataTypes) => {
           fields: ["page_code"],
           comment: "For page code filtering",
         },
+        {
+          name: "idx_campaign_logs_platform_code",
+          fields: ["platform_code"],
+          comment: "For canonical platform filtering",
+        },
         {
           fields: ["process_id"],
         },

package/models/CampaignCreationLogV2.js

@@ -109,6 +109,13 @@ module.exports = (sequelize, DataTypes) => {
         type: DataTypes.STRING(50),
         allowNull: true,
       },
+      platform_code: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment:
+          "Canonical ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
       language: {
         type: DataTypes.STRING(50),
         allowNull: true,
@@ -277,6 +284,7 @@ module.exports = (sequelize, DataTypes) => {
         { fields: ["account_id", "status"] },
         { fields: ["vertical", "feed_provider"] },
         { fields: ["details"], using: "gin" },
+        { fields: ["platform_code"] },
       ],
     }
   );

package/models/CanonicalInsights.js

@@ -0,0 +1,68 @@
+module.exports = (sequelize, DataTypes) => {
+  const CanonicalInsights = sequelize.define(
+    "CanonicalInsights",
+    {
+      id: {
+        type: DataTypes.BIGINT,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      platform: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        comment: "Ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
+      entity_type: {
+        type: DataTypes.ENUM("campaign", "adset", "ad"),
+        allowNull: false,
+      },
+      entity_id: {
+        type: DataTypes.STRING(64),
+        allowNull: false,
+      },
+      date: {
+        type: DataTypes.DATEONLY,
+        allowNull: false,
+      },
+      impressions: {
+        type: DataTypes.BIGINT,
+        defaultValue: 0,
+      },
+      clicks: {
+        type: DataTypes.BIGINT,
+        defaultValue: 0,
+      },
+      spend: {
+        type: DataTypes.DECIMAL(14, 4),
+        defaultValue: 0,
+      },
+      conversions: {
+        type: DataTypes.BIGINT,
+        defaultValue: 0,
+      },
+      revenue: {
+        type: DataTypes.DECIMAL(14, 4),
+        defaultValue: 0,
+      },
+      raw_payload: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+    },
+    {
+      tableName: "canonical_insights",
+      indexes: [
+        {
+          unique: true,
+          name: "canonical_insights_unique_per_entity_date",
+          fields: ["platform", "entity_type", "entity_id", "date"],
+        },
+        {
+          fields: ["platform", "date"],
+        },
+      ],
+    }
+  );
+
+  return CanonicalInsights;
+};

package/models/RSOCFeedCampaign.js

@@ -160,6 +160,12 @@ module.exports = (sequelize, DataTypes) => {
         type: DataTypes.STRING,
         allowNull: false,
       },
+      platform_code: {
+        type: DataTypes.ENUM("fb", "tt", "snp"),
+        allowNull: false,
+        defaultValue: "fb",
+        comment: "Canonical ad platform identifier: fb=Facebook, tt=TikTok, snp=Snapchat",
+      },
       mediaBuyer: {
         type: DataTypes.STRING,
         allowNull: true,

package/models/SnapchatAd.js

@@ -0,0 +1,69 @@
+module.exports = (sequelize, DataTypes) =>
+  sequelize.define(
+    "SnapchatAd",
+    {
+      id: {
+        type: DataTypes.STRING(36),
+        primaryKey: true,
+        comment: "Snapchat ad UUID",
+      },
+      name: {
+        type: DataTypes.STRING(255),
+        allowNull: false,
+      },
+      ad_squad_id: {
+        type: DataTypes.STRING(36),
+        allowNull: false,
+        comment: "Snapchat ad squad UUID; loose FK to snapchat_ad_squads",
+      },
+      ad_account_id: {
+        type: DataTypes.STRING(36),
+        allowNull: false,
+      },
+      creative_id: {
+        type: DataTypes.STRING(36),
+        allowNull: false,
+      },
+      status: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "ACTIVE or PAUSED (Snap native)",
+      },
+      type: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "SNAP_AD",
+      },
+      review_status: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "Mirrors Plan Q Ad.review_status (e.g. PENDING_REVIEW, APPROVED)",
+      },
+      pending_review_since: {
+        type: DataTypes.DATE,
+        allowNull: true,
+        comment: "Timestamp when ad first entered pending review (Plan Q)",
+      },
+      created_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      synced_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+    },
+    {
+      tableName: "snapchat_ads",
+      timestamps: false,
+      indexes: [
+        { fields: ["ad_squad_id"] },
+        { fields: ["ad_account_id"] },
+        { fields: ["status"] },
+      ],
+    },
+  );

package/models/SnapchatAdSquad.js

@@ -0,0 +1,92 @@
+module.exports = (sequelize, DataTypes) =>
+  sequelize.define(
+    "SnapchatAdSquad",
+    {
+      id: {
+        type: DataTypes.STRING(36),
+        primaryKey: true,
+        comment: "Snapchat ad squad UUID",
+      },
+      name: {
+        type: DataTypes.STRING(255),
+        allowNull: false,
+      },
+      campaign_id: {
+        type: DataTypes.STRING(36),
+        allowNull: false,
+        comment: "Snapchat campaign UUID; loose FK to snapchat_campaigns",
+      },
+      ad_account_id: {
+        type: DataTypes.STRING(36),
+        allowNull: false,
+      },
+      status: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "ACTIVE or PAUSED (Snap native)",
+      },
+      type: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "SNAP_ADS",
+      },
+      bid_strategy: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+      },
+      optimization_goal: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+      },
+      billing_event: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+      },
+      placement_v2: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+        comment: "Snap placement_v2 config (e.g. {config:'AUTOMATIC', ...})",
+      },
+      daily_budget_micro: {
+        type: DataTypes.BIGINT,
+        allowNull: true,
+      },
+      bid_micro: {
+        type: DataTypes.BIGINT,
+        allowNull: true,
+      },
+      targeting: {
+        type: DataTypes.JSONB,
+        allowNull: true,
+      },
+      start_time: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      end_time: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      created_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      synced_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+    },
+    {
+      tableName: "snapchat_ad_squads",
+      timestamps: false,
+      indexes: [
+        { fields: ["campaign_id"] },
+        { fields: ["ad_account_id"] },
+        { fields: ["status"] },
+      ],
+    },
+  );

package/models/SnapchatCampaign.js

@@ -0,0 +1,69 @@
+module.exports = (sequelize, DataTypes) =>
+  sequelize.define(
+    "SnapchatCampaign",
+    {
+      id: {
+        type: DataTypes.STRING(36),
+        primaryKey: true,
+        comment: "Snapchat UUID",
+      },
+      name: {
+        type: DataTypes.STRING(255),
+        allowNull: false,
+      },
+      ad_account_id: {
+        type: DataTypes.STRING(36),
+        allowNull: false,
+      },
+      status: {
+        type: DataTypes.STRING(50),
+        allowNull: false,
+        comment: "ACTIVE or PAUSED (Snap native)",
+      },
+      objective: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+      },
+      daily_budget_micro: {
+        type: DataTypes.BIGINT,
+        allowNull: true,
+      },
+      lifetime_spend_cap_micro: {
+        type: DataTypes.BIGINT,
+        allowNull: true,
+      },
+      timezone: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+      },
+      start_time: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      end_time: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      created_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      synced_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+    },
+    {
+      tableName: "snapchat_campaigns",
+      timestamps: false,
+      indexes: [
+        { fields: ["ad_account_id"] },
+        { fields: ["created_at"] },
+        { fields: ["status"] },
+      ],
+    },
+  );

package/models/SnapchatPublicProfiles.js

@@ -0,0 +1,47 @@
+module.exports = (sequelize, DataTypes) => {
+  const SnapchatPublicProfiles = sequelize.define(
+    "SnapchatPublicProfiles",
+    {
+      id: {
+        type: DataTypes.BIGINT,
+        primaryKey: true,
+        autoIncrement: true,
+      },
+      public_profile_id: {
+        type: DataTypes.STRING(64),
+        allowNull: false,
+        unique: true,
+        comment:
+          "Snapchat public_profile_id used as creative owner on ad creation",
+      },
+      name: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+      },
+      ad_account_id: {
+        type: DataTypes.STRING(64),
+        allowNull: false,
+        comment: "Snapchat ad_account_id this profile belongs to",
+      },
+      status: {
+        type: DataTypes.STRING(16),
+        allowNull: false,
+        defaultValue: "active",
+        comment: "active | disabled",
+      },
+      tier: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+        defaultValue: 1,
+        comment:
+          "Rotation weight. Higher tier => higher probability of being picked.",
+      },
+    },
+    {
+      tableName: "snapchat_public_profiles",
+      indexes: [{ fields: ["ad_account_id", "status"] }],
+    }
+  );
+
+  return SnapchatPublicProfiles;
+};

package/models/TikTokAd.js

@@ -0,0 +1,71 @@
+module.exports = (sequelize, DataTypes) =>
+  sequelize.define(
+    "TikTokAd",
+    {
+      ad_id: {
+        type: DataTypes.BIGINT,
+        primaryKey: true,
+      },
+      ad_name: {
+        type: DataTypes.STRING(255),
+        allowNull: false,
+      },
+      adgroup_id: {
+        type: DataTypes.BIGINT,
+        allowNull: false,
+        comment: "TikTok adgroup_id; loose FK to tiktok_adgroups (no DB-level constraint)",
+      },
+      campaign_id: {
+        type: DataTypes.BIGINT,
+        allowNull: false,
+      },
+      ad_account_id: {
+        type: DataTypes.STRING(64),
+        allowNull: false,
+      },
+      ad_format: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "SINGLE_VIDEO, SINGLE_IMAGE, etc.",
+      },
+      identity_id: {
+        type: DataTypes.STRING(64),
+        allowNull: true,
+        comment: "TikTok identity (Page equivalent)",
+      },
+      landing_page_url: {
+        type: DataTypes.TEXT,
+        allowNull: true,
+      },
+      display_name: {
+        type: DataTypes.STRING(255),
+        allowNull: true,
+      },
+      operation_status: {
+        type: DataTypes.STRING(50),
+        allowNull: true,
+        comment: "ENABLE or DISABLE (TikTok native)",
+      },
+      created_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+      updated_at: {
+        type: DataTypes.DATE,
+        allowNull: true,
+      },
+      synced_at: {
+        type: DataTypes.DATE,
+        allowNull: false,
+      },
+    },
+    {
+      tableName: "tiktok_ads",
+      timestamps: false,
+      indexes: [
+        { fields: ["adgroup_id"] },
+        { fields: ["campaign_id"] },
+        { fields: ["operation_status"] },
+      ],
+    },
+  );