@sellout/models 0.0.1

package/src/schemas/Event.ts

@@ -0,0 +1,400 @@
+import shortid from 'shortid';
+import { EventAgeEnum, SendQRCodeEnum, EventProcessAsEnum } from '../interfaces/IEvent';
+import Address from './Address';
+import Metrics from './Metrics';
+
+const EventCustomFields = {
+  _id: {
+    type: String,
+    default: shortid.generate
+  },
+  label: {
+    type: String,
+    required: false
+  },
+  type: {
+    type: String,
+    required: true
+  },
+  minLength: {
+    type: Number,
+    required: true,
+    default: 0
+  },
+  maxLength: {
+    type: Number,
+    required: false,
+    default: null,
+  },
+  minValue: {
+    type: Number,
+    required: true,
+    default: 0
+  },
+  maxValue: {
+    type: Number,
+    required: false,
+    default: null
+  },
+  required: {
+    type: Boolean,
+    required: true,
+    default: false,
+  },
+  active: {
+    type: Boolean,
+    required: true,
+    default: true
+  }
+};
+
+const EventPromotion = {
+  _id: {
+    type: String,
+    default: shortid.generate,    
+  },
+  code: {
+    type: String,
+    required: true,
+  },
+  type: {
+    type: String,
+    required: true
+  },
+  totalQty: {
+    type: Number,
+    required: true
+  },
+  remainingQty: {
+    type: Number,
+    required: true
+  },
+  ticketTypeIds: [
+    {
+      type: String,
+      required: true,
+      default: []
+    }
+  ],
+  upgradeIds: [
+    {
+      type: String,
+      required: true,
+      default: []
+    }
+  ],
+  active: {
+    type: Boolean,
+    required: true,
+    default: true,
+  }
+};
+
+const EventFee = {
+  name: {
+    type: String,
+    required: true,
+  },
+  type: {
+    type: String,
+    required: true,
+  },
+  amount: {
+    type: Number,
+    required: true,
+  },
+};
+
+const EventSchedule = {
+  announceAt: {
+    type: Number,
+    required: false,
+  },
+  ticketsAt: {
+    type: Number,
+    required: false,
+  },
+  ticketsEndAt: {
+    type: Number,
+    required: false,
+  },
+  startsAt: {
+    type: Number,
+    required: false,
+  },
+  endsAt: {
+    type: Number,
+    required: false,
+  },
+};
+
+const EventUpgrade = {
+  name: {
+    type: String,
+    required: true,
+  },
+  price: {
+    type: Number,
+    required: true,
+  },
+  totalQty: {
+    type: Number,
+    required: true,
+  },
+  remainingQty: {
+    type: Number,
+    required: true,
+  },
+  purchaseLimit: {
+    type: Number,
+    required: true,
+    default: 8,
+  },
+  complimentary: {
+    type: Boolean,
+    required: true,
+    default: false,
+  },
+  ticketTypeIds: [
+    {
+      type: String,
+      required: true,
+    }
+  ],
+  imageUrl: {
+    type: String,
+    required: false,
+  },
+  description: {
+    type: String,
+    required: false,
+  },
+  visible: {
+    type: Boolean,
+    required: true,
+    default: true,
+  },
+};
+
+export const PerformanceSchedule = {
+  doorsAt: {
+    type: Number,
+    required: false,
+  },
+  startsAt: {
+    type: Number,
+    required: false,
+  },
+};
+
+const Performance = {
+  name: {
+    type: String,
+    required: false,
+  },
+  headliningArtistIds: [
+    {
+      type: String,
+      required: false,
+    }
+  ],
+  openingArtistIds: [
+    {
+      type: String,
+      requird: false,
+    }
+  ],
+  venueId: {
+    type: String,
+    required: false,
+  },
+  venueStageId: {
+    type: String,
+    required: false,
+  },
+  price: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  posterImageUrl: {
+    type: String,
+    required: false,
+  },
+  videoLink: {
+    type: String,
+    required: false,
+  },
+  songLink: {
+    type: String,
+    required: false,
+  },
+  schedule: PerformanceSchedule,
+};
+
+const TicketExchange = {
+  allowed: {
+    type: String,
+    required: false,
+  },
+  percent: {
+    type: String,
+    required: false,
+  },
+};
+
+const TicketHold = {
+  name: {
+    type: String,
+    required: true,
+  },
+  qty: {
+    type: Number,
+    required: true,
+  },
+  ticketTypeId: {
+    type: String,
+    required: true,
+  },
+};
+
+const TicketTier = {
+  name: {
+    type: String,
+    required: true,
+  },
+  price: {
+    type: Number,
+    required: true,
+  },
+  startsAt: {
+    type: Number,
+    required: true,
+  },
+  endsAt: {
+    type: Number,
+    required: true,
+  },
+  totalQty: {
+    type: Number,
+    required: true,
+  },
+  remainingQty: {
+    type: Number,
+    required: true,
+  },
+};
+
+const TicketType = {
+  name: {
+    type: String,
+    required: true,
+  },
+  totalQty: {
+    type: Number,
+    required: true,
+  },
+  remainingQty: {
+    type: Number,
+    required: true,
+  },
+  purchaseLimit: {
+    type: Number,
+    required: true,
+    default: 8,
+  },
+  visible: {
+    type: Boolean,
+    required: true,
+    default: true,
+  },
+  performanceIds: [
+    {
+      type: String,
+      required: false,
+      default: [],
+    }
+  ],
+  tiers: [TicketTier]
+};
+
+
+export default {
+  _id: {
+    type: String,
+    default: shortid.generate
+  },
+  orgId: {
+    type: String,
+    required: true
+  },
+  type: {
+    type: String,
+    required: false
+  },
+  name: {
+    type: String,
+    required: false
+  },
+  subtitle: {
+    type: String,
+    required: false
+  },
+  description: {
+    type: String,
+    required: false
+  },
+  posterImageUrl: {
+    type: String,
+    required: false
+  },
+  venueId: {
+    type: String,
+    required: false
+  },
+  createdAt: {
+    type: Number,
+    required: true
+  },
+  publishable: {
+    type: Boolean,
+    required: true,
+    default: false
+  },
+  seatingChartKey: {
+    type: String,
+    required: false,
+  },
+  age: {
+    type: String,
+    required: true,
+    default: EventAgeEnum.AllAges
+  },
+  active: {
+    type: Boolean,
+    default: true
+  },
+  userAgreement: {
+    type: String,
+    required: false
+  },
+  processAs: {
+    type: String,
+    required: true,
+    default: EventProcessAsEnum.Paid,
+  },
+  sendQRCode: {
+    type: String,
+    default: SendQRCodeEnum.UponOrder,
+  },
+  location: Address,
+  schedule: EventSchedule,
+  performances: [Performance],
+  ticketTypes: [TicketType],
+  holds: [TicketHold],
+  upgrades: [EventUpgrade],
+  promotions: [EventPromotion],
+  customFields: [EventCustomFields],
+  exchange: TicketExchange,
+  metrics: Metrics
+};

package/src/schemas/Fee.ts

@@ -0,0 +1,74 @@
+import shortid from 'shortid';
+
+export default {
+  _id: {
+    type: String,
+    default: shortid.generate,
+  },
+  name: {
+    type: String,
+    required: true,
+  },
+  orgId: {
+    type: String,
+    required: false,
+    default: null,
+  },
+  eventId: {
+    type: String,
+    required: false,
+    default: null,
+  },
+  type: {
+    type: String,
+    required: true,
+  },
+  value: {
+    type: Number,
+    required: true,
+  },
+  appliedTo: {
+    type: String,
+    required: true,
+  },
+  appliedBy: {
+    type: String,
+    required: true,
+  },
+  minAppliedToPrice: {
+    type: Number,
+    required: false,
+    default: null,
+  },
+  maxAppliedToPrice: {
+    type: Number,
+    required: false,
+    default: null,
+  },
+  filters: [{
+    type: String,
+    required: false,
+    default: [],
+  }],
+  createdBy: {
+    type: String,
+    required: true,
+  },
+  createdAt: {
+    type: Number,
+    required: true,
+  },
+  updatedBy: { 
+    type: String,
+    required: true,
+  },
+  updatedAt: {
+    type: Number,
+    required: true,
+  },
+  disabled: {
+    type: Boolean,
+    required: true,
+    default: false,
+  },
+};

package/src/schemas/Metrics.ts

@@ -0,0 +1,134 @@
+export default {
+  orgId: {
+    type: String,
+    required: false,
+  },
+  createdAt: {
+    type: Number,
+    required: false,
+  },
+  // Value
+  lifeTimeValue: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateValue: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeValueRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateValueRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeValueComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateValueComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  // Tickets
+  lifeTimeTicketsPurchased: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateTicketsPurchased: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeTicketsRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateTicketsRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeTicketsComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateTicketsComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  // Upgrades
+  lifeTimeUpgradesPurchased: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateUpgradesPurchased: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeUpgradesRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateUpgradesRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeUpgradesComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateUpgradesComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  // Orders
+  lifeTimeOrdersPurchased: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateOrdersPurchased: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeOrdersRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateOrdersRefunded: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  lifeTimeOrdersComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+  yearToDateOrdersComped: {
+    type: Number,
+    required: false,
+    default: 0,
+  },
+};