@sellout/models 0.0.1

package/src/interfaces/IEvent.ts

@@ -0,0 +1,62 @@
+import IAddress from "@sellout/models/.dist/interfaces/IAddress";
+import IMetrics from "@sellout/models/.dist/interfaces/IMetrics";
+import ITicketType from './ITicketType';
+import IEventSchedule from './IEventSchedule'; 
+import ITicketExchange from './ITicketExchange';
+import IEventUpgrade from './IEventUpgrade';
+import ITicketHold from './ITicketHold';
+import IPerformance from './IPerformance';
+import IEventPromotion from './IEventPromotion';
+import IEventCustomField from './IEventCustomField';
+
+export enum EventTypeEnum {
+  Concert = 'Concert',
+  BasicEvent = 'Basic Event',
+}
+
+export enum EventAgeEnum {
+  AllAges = 'All Ages',
+  EighteenPlus = '18+',
+  TwentyOnePlus = '21+',
+}
+
+export enum SendQRCodeEnum {
+  DayOfShow = 'Day of Show',
+  UponOrder = 'Upon Order',
+  TwoWeeksBefore = 'Two Weeks Before Show',
+}
+
+export enum EventProcessAsEnum {
+  Paid = 'Paid',
+  RSVP = 'RSVP',
+  Free = 'Free'
+}
+
+export default interface IEvent {
+  _id?: string;
+  orgId: string;
+  type: EventTypeEnum;
+  name?: string;
+  subtitle?: string;
+  description?: string;
+  posterImageUrl?: string;
+  venueId?: string;
+  createdAt: number;
+  publishable: boolean;
+  seatingChartKey?: string;
+  age?: EventAgeEnum;
+  active?: boolean;
+  userAgreement?: string;
+  processAs?: EventProcessAsEnum;
+  sendQRCode?: SendQRCodeEnum;
+  location?: IAddress;
+  schedule?: IEventSchedule;
+  performances?: IPerformance[];
+  ticketTypes?: ITicketType[];
+  holds?: ITicketHold[];
+  upgrades?: IEventUpgrade[];
+  promotions?: IEventPromotion[];
+  customFields?: IEventCustomField[];
+  exchange?: ITicketExchange;
+  metrics: IMetrics;
+}

package/src/interfaces/IEventCustomField.ts

@@ -0,0 +1,16 @@
+export enum EventCustomFieldTypeEnum {
+  Text = 'Text',
+  Number = 'Number',
+}
+
+export default interface IEventCustomFields {
+  _id?: string;
+  label?: string;
+  type: EventCustomFieldTypeEnum;
+  minLength: number;
+  maxLength: number;
+  maxValue: number;
+  minValue: number;
+  required: boolean;
+  active: boolean;
+}

package/src/interfaces/IEventPromotion.ts

@@ -0,0 +1,15 @@
+export enum EventPromotionTypeEnum {
+  PreSale = "Pre-Sale Code",
+  Secret = "Secret Code",
+}
+
+export default interface IEventPromotion {
+  _id?: string;
+  code: string;
+  type: EventPromotionTypeEnum;
+  totalQty: number;
+  remainingQty: number;
+  ticketTypeIds: string[];
+  upgradeIds: string[];
+  active: boolean;
+}

package/src/interfaces/IEventSchedule.ts

@@ -0,0 +1,7 @@
+export default interface IEventSchedule {
+  announceAt?: number;
+  ticketsAt?: number;
+  ticketsEndAt?: number;
+  startsAt?: number;
+  endsAt?: number;
+}

package/src/interfaces/IEventUpgrade.ts

@@ -0,0 +1,13 @@
+export default interface IEventUpgrade {
+  _id?: string;
+  name: string;
+  price: number;
+  totalQty: number;
+  remainingQty: number;
+  purchaseLimit: number;
+  complimentary: boolean;
+  ticketTypeIds: string[];
+  imageUrl: string;
+  description: string;
+  visible: boolean;
+}

package/src/interfaces/IFee.ts

@@ -0,0 +1,46 @@
+export enum FeeTypeEnum {
+  Flat = 'Flat',
+  Percent = 'Percent',
+  FlatPlusPercent = 'Flat + Percent',
+}
+
+export enum FeeAppliedToEnum {
+  Order = 'Order',
+  Ticket = 'Ticket',
+  Upgrade = 'Upgrade',
+}
+
+export enum FeeAppliedByEnum {
+  Sellout = 'Sellout',
+  Stripe = 'Stripe',
+  Organization = 'Organization',
+}
+
+export enum FeeFilters {
+  // Online = 'Online Orders Only',
+  // BoxOffice = 'Box Office Orders Only',
+  Seated = 'Seated',
+  // FirstOrder = 'FirstOrder',
+}
+
+export default interface IFee {
+  _id?: string;
+  name: string;
+  orgId?: string;
+  eventId?: string;
+  type: FeeTypeEnum;
+  value: number;
+  appliedTo: FeeAppliedToEnum;
+  appliedBy: FeeAppliedByEnum;
+  minAppliedToPrice?: number;
+  maxAppliedToPrice?: number;
+  filters?: FeeFilters[];
+  createdBy: string;
+  createdAt: number;
+  updatedBy: string;
+  updatedAt: number;
+  disabled: boolean;
+  // disableable: boolean;
+  // editable: boolean;
+  // isGlobal: boolean;
+}

package/src/interfaces/IFile.ts

@@ -0,0 +1,7 @@
+export default interface IFile {
+  file?: any;
+  mimetype?: string;
+  filename?: string;
+  encoding?: string;
+  url?: string;
+}

package/src/interfaces/IMetrics.ts

@@ -0,0 +1,33 @@
+export default interface IMetrics {
+  _id?: string;
+  orgId: string;
+  createdAt: number;
+  // Value
+  lifeTimeValue?: number;
+  yearToDateValue?: number;
+  lifeTimeValueRefunded?: number;
+  yearToDateValueRefunded?: number;
+  lifeTimeValueComped?: number;
+  yearToDateValueComped?: number;
+  // Tickets
+  lifeTimeTicketsPurchased?: number;
+  yearToDateTicketsPurchased?: number;
+  lifeTimeTicketsRefunded?: number;
+  yearToDateTicketsRefunded?: number;
+  lifeTimeTicketsComped?: number;
+  yearToDateTicketsComped?: number;
+  // Upgrades
+  lifeTimeUpgradesPurchased?: number;
+  yearToDateUpgradesPurchased?: number;
+  lifeTimeUpgradesRefunded?: number;
+  yearToDateUpgradesRefunded?: number;
+  lifeTimeUpgradesComped?: number;
+  yearToDateUpgradesComped?: number;
+  // Orders
+  lifeTimeOrdersPurchased?: number;
+  yearToDateOrdersPurchased?: number;
+  lifeTimeOrdersRefunded?: number;
+  yearToDateOrdersRefunded?: number; 
+  lifeTimeOrdersComped?: number;
+  yearToDateOrdersComped?: number;
+}

package/src/interfaces/IOrder.ts

@@ -0,0 +1,32 @@
+import IAddress from "@sellout/models/.dist/interfaces/IAddress";
+import IOrderTicket from './IOrderTicket';
+import IOrderUpgrade from './IOrderUpgrade';
+import IOrderCustomField from './IOrderCustomField'
+import { OrderStateEnum } from './IOrderState';
+import { OrderTypeEnum } from './IOrderType';
+
+export default interface IOrder {
+  _id?: string;
+  secretId?: string;
+  orgId: string;
+  userId: string;
+  eventId: string;
+  eventName: string;
+  venueIds: string[];
+  artistIds: string[];
+  feeIds: string[];
+  stripeChargeId?: string;
+  tickets: IOrderTicket[];
+  upgrades: IOrderUpgrade[];
+  recipientEmails?: string[];
+  qrCodeUrl?: string;
+  state?: OrderStateEnum,
+  refundedAmount?: number;
+  type?: OrderTypeEnum;
+  createdAt?: number;
+  createdBy?: string;
+  promotionCode?: string;
+  ipAddress?: string;
+  address?: IAddress
+  customFields?: IOrderCustomField[];
+};

package/src/interfaces/IOrderCustomField.ts

@@ -0,0 +1,7 @@
+export default interface IOrderCustomField {
+  _id?: string;
+  label: string;
+  value: string;
+  customFieldId: string;
+  type: string,
+};

package/src/interfaces/IOrderState.ts

@@ -0,0 +1,19 @@
+export enum OrderStateEnum {
+  ACTIVE = 'Active',
+  REFUNDED = 'Refunded',
+  PARTIALLY_REFUNDED = 'Partial Refund',
+  // TRANSFERRED = 'Transferred',
+  // RESOLD = 'Re-sold',
+  // PARTIALLY_ADMITTED = 'Partially Admitted',
+  // ADMITTED = 'Admitted',
+};
+
+export enum OrderItemStateEnum {
+  ACTIVE = 'Active',
+  CANCELED = 'Canceled',
+  // AWATING_TRANSFER = 'Awaiting Transfer',
+  // TRANSFERRED = 'Transferred',
+  // AWATING_SALE = 'Awaiting Sale',
+  // RESOLD = 'Re-sold',
+  // SCANNED = 'Scanned',
+};

package/src/interfaces/IOrderSummary.ts

@@ -0,0 +1,37 @@
+import { OrderStateEnum } from './IOrderState';
+
+export interface IOrderSummaryItem {
+  typeId: string;
+  name: string;
+  price: number;
+  count: number;
+  scannedCount: number;
+  seats?: string[];
+}
+
+export default interface IOrderSummary {
+  state: OrderStateEnum;
+  total: number | string;
+  orderTotalWithRefund: number | string;
+  subtotal: number | string;
+  selloutFee: number | string;
+  stripeFee: number | string;
+  promoterFee: number | string;
+  createdAt: number | string;
+  tickets: IOrderSummaryItem[];
+  upgrades: IOrderSummaryItem[];
+  ticketsScanned?: number;
+  totalTickets?: number;
+  upgradesScanned?: number;
+  totalUpgrades?: number;
+  orgName?: string;
+  userFirstName?: string;
+  userLastName?: string;
+  userEmail?: string;
+  userPhoneNumber?: string;
+  eventName?: string;
+  venueNames?: string[];
+  venueName?: string;
+  artistNames?: string[];
+  aritstName?: string;
+}

package/src/interfaces/IOrderTicket.ts

@@ -0,0 +1,15 @@
+import IRefund from './IRefund';
+import IScan from './IScan';
+import { OrderItemStateEnum } from './IOrderState';
+
+export default interface IOrderTicket {
+  _id?: string;
+  name: string;
+  ticketTypeId: string;
+  ticketTierId: string;
+  price: number;
+  seat: string;
+  refund: IRefund;
+  scan: IScan;
+  state: OrderItemStateEnum;
+};

package/src/interfaces/IOrderType.ts

@@ -0,0 +1,5 @@
+export enum OrderTypeEnum {
+  Online = 'Online',
+  Complimentary = 'Complimentary',
+  RSVP = 'RSVP',
+};

package/src/interfaces/IOrderUpgrade.ts

@@ -0,0 +1,14 @@
+import IRefund from './IRefund';
+import IScan from './IScan';
+import { OrderItemStateEnum } from './IOrderState';
+
+export default interface IOrderUpgrade {
+  _id?: string;
+  name: string;
+  upgradeId: string;
+  price: number;
+  total: number;
+  refund: IRefund;
+  scan: IScan;
+  state: OrderItemStateEnum;
+}

package/src/interfaces/IOrganization.ts

@@ -0,0 +1,19 @@
+import IAddress from "@sellout/models/.dist/interfaces/IAddress";
+
+export default interface IOrganization {
+  _id?: string;
+  userId?: string;
+  createdAt?: number;
+  authyId?: string;
+  stripeId?: string;
+  orgName?: string;
+  orgUrls?: string[];
+  address?: IAddress;
+  orgLogoUrl?: string;
+  orgColorHex?: string;
+  bio?: string;
+  email?: string;
+  phoneNumber?: string;
+  facebookPixelId?: string;
+  googleAnalyticsId?: string;
+}

package/src/interfaces/IPagination.ts

@@ -0,0 +1,4 @@
+export default interface IPagination {
+  pageSize: number;
+  pageNumber: number;
+}

package/src/interfaces/IPerformance.ts

@@ -0,0 +1,18 @@
+export interface IPerformanceSchedule {
+  doorsAt: string;
+  startsAt: string;
+}
+
+export default interface IPerformance {
+  _id?: string;
+  name?: string;
+  headliningArtistIds?: string[];
+  openingArtistIds?: string[];
+  venueId?: string;
+  venueStageId?: string;
+  price?: number;
+  posterImageUrl?: string;
+  videoLink?: string;
+  songLink?: string;
+  schedule?: IPerformanceSchedule;
+}

package/src/interfaces/IQuery.ts

@@ -0,0 +1,30 @@
+export interface IQuery {
+  any: string;
+  userId: string;
+  eventId: string;
+  artistId: string;
+  venueId: string;
+  startDate: number;
+  endDate: number;
+}
+
+export interface IPbQuery {
+  key: string;
+  value: any;
+}
+
+export function toPb(query: object): IPbQuery[] {
+  let pbQuery: IPbQuery[] = Object.keys(query).reduce((cur, key) => {
+    if (!query[key]) return cur;
+    cur.push({ key: key, value: query[key] } as IPbQuery);
+    return cur;
+  }, [] as IPbQuery[]);
+  return pbQuery;
+}
+
+export function fromPb(query: IPbQuery[]): IQuery {
+  return query.reduce((c, n) => {
+    c[n.key] = n.value;
+    return c;
+  }, {} as IQuery);
+}

package/src/interfaces/IRefund.ts

@@ -0,0 +1,6 @@
+export default interface IRefund {
+  refunded: boolean;
+  refundedAt: number;
+  refundedBy: string;
+  refundedAmount: number;
+}

package/src/interfaces/IRole.ts

@@ -0,0 +1,17 @@
+export declare enum Roles {
+  OWNER = 'OWNER',
+  ADMIN = 'ADMIN',
+  BOX_OFFICE = 'BOX_OFFICE',
+  SCANNER = 'SCANNER',
+}
+
+export default interface IRole {
+  _id?: string;
+  orgId: string;
+  userId?: string;
+  userEmail: string;
+  createdAt: number;
+  createdBy: string;
+  role: Roles;
+  acceptedAt?: number;
+}

package/src/interfaces/IScan.ts

@@ -0,0 +1,5 @@
+export default interface IScan {
+  scanned: boolean;
+  scannedAt: number;
+  scannedBy: string;
+}

package/src/interfaces/ISeating.ts

@@ -0,0 +1,9 @@
+export default interface ISeating {
+  _id?: string;
+  orgId: string;
+  publicKey: string;
+  secretKey: string;
+  designerKey: string;
+  createdAt: number;
+  updatedAt?: number;
+}

package/src/interfaces/ISocialAccountLink.ts

@@ -0,0 +1,14 @@
+export enum SocialAccountPlatform {
+  SoundClound = 'SoundCloud',
+  Facebook = 'Facebook',
+  Spotify = 'Spotify',
+  BandCamp = 'BandCamp',
+  YouTube = 'YouTube',
+  AppleMusic = 'Apple Music',
+  Instagram = 'Instagram',
+}
+
+export interface ISocialAccountLink {
+  platform: SocialAccountPlatform;
+  link: string;
+}

package/src/interfaces/ITask.ts

@@ -0,0 +1,22 @@
+export enum TaskTypes {
+  SendOrderQrCodeEmail = 'SendOrderQrCodeEmail',
+  UpdateWebFlowEvent = 'UpdateWebFlowEvent',
+}
+
+export default interface ITask {
+  _id?: string;
+  taskType: TaskTypes;
+  createdAt?: number;
+  executeAt: number;
+  startedAt?: number;
+  endedAt?: number;
+  success?: boolean;
+  canceledAt?: number;
+  userId?: string;
+  orgId?: string;
+  eventId?: string;
+  orderId?: string;
+  venueIds?: string[];
+  artistIds?: string[];
+}
+

package/src/interfaces/ITicketExchange.ts

@@ -0,0 +1,11 @@
+export enum TicketExchangeAllowedEnum {
+  Always = "Always",
+  Never = 'Never',
+  After = 'After event is sold out',
+  Percent = 'After a percent of tickets are sold',
+}
+
+export default interface ITicketExchange {
+  allowed: TicketExchangeAllowedEnum
+  percent: number;
+}

package/src/interfaces/ITicketHold.ts

@@ -0,0 +1,6 @@
+export default interface ITicketHold {
+  _id?: string;
+  name: string;
+  qty: number;
+  ticketTypeId: string;
+}

package/src/interfaces/ITicketTier.ts

@@ -0,0 +1,9 @@
+export default interface ITicketTier {
+  _id?: string;
+  name: string;
+  price: number;
+  startsAt: number;
+  endsAt: number;
+  totalQty: number;
+  remainingQty: number;
+}

package/src/interfaces/ITicketType.ts

@@ -0,0 +1,12 @@
+import ITicketTier from './ITicketTier'
+
+export default interface ITicketType {
+  _id?: string;
+  name: string;
+  totalQty: number;
+  remainingQty: number;
+  purchaseLimit: number;
+  visible: boolean;
+  performanceIds: string[];
+  tiers: ITicketTier[];
+}

package/src/interfaces/IUser.ts

@@ -0,0 +1,26 @@
+export enum LoginTypes {
+  PhoneCode = 'PhoneCode',
+  Password = 'Password',
+  TwoFactor = 'TwoFactor',
+}
+
+export default interface IUser {
+  _id?: string;
+  email: string;
+  password?: string;
+  passwordHash?: string;
+  firstName: string;
+  lastName: string;
+  createdAt?: number;
+  phoneNumber?: string;
+  phoneNumberVerifiedAt?: number;
+  emailVerifyCode?: string;
+  emailVerifiedAt?: number;
+  forgotPasswordCode?: string;
+  lastChangedPasswordAt?: number;
+  orgContextId?: string;
+  orgRole?: string;
+  phoneNumberWaitingForVerify?: string;
+  emailWaitingForVerify?: string;
+  preferredLogin?: LoginTypes;
+}

package/src/interfaces/IUserProfile.ts

@@ -0,0 +1,20 @@
+import IAddress from "@sellout/models/.dist/interfaces/IAddress";
+import IMetrics from "@sellout/models/.dist/interfaces/IMetrics";
+
+export default interface IUserProfile {
+  _id?: string;
+  userId: string;
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+  phoneNumber?: string;
+  authyId?: string;
+  stripeCustomerId?: string;
+  imageUrl?: string;
+  metrics?: IMetrics[];
+  orgIds?: string[];
+  eventIds?: string[];
+  venueIds?: string[];
+  artistIds?: string[];
+  address?: IAddress;
+}

package/src/interfaces/IVenue.ts

@@ -0,0 +1,17 @@
+import IAddress from "@sellout/models/.dist/interfaces/IAddress";
+import IMetrics from "@sellout/models/.dist/interfaces/IMetrics";
+
+export default interface IVenue {
+  _id?: string;
+  name: string;
+  description: string;
+  capacity: number;
+  address: IAddress;
+  url?: string;
+  imageUrls?: string[];
+  seatingMapIds?: string[];
+  venueGlobalId?: string;
+  orgId?: string;
+  venueFee?: number;
+  metrics?: IMetrics;
+}

package/src/interfaces/IWebFlow.ts

@@ -0,0 +1,55 @@
+export enum WebFlowEntityType {
+  VENUE = "VENUE",
+  EVENT = "EVENT",
+  ARTIST = "ARTIST",
+  ORGANIZATION = "ORGANIZATION",
+}
+
+export interface IWebFlowEntityId {
+  webFlowSiteId: string;
+  webFlowEntityId: string;
+  slug: string;
+  webFlowSite?: IWebFlowSite;
+}
+
+export interface IWebFlowEntity {
+  _id?: string;
+  entityType: WebFlowEntityType,
+  name: string;
+  selloutId: string;
+  webFlowIds: IWebFlowEntityId[];
+  alwaysPublishTo?: string[];
+  createdAt: number;
+  updatedAt?: number;
+}
+
+export interface IWebFlowSiteDomain {
+  _id?: string;
+  name: string;
+  lastPublishedAt: number;
+}
+
+export interface IWebFlowSite {
+  _id?: string;
+  name: string;
+  webFlowId: string;
+  enabled: boolean;
+  eventCollectionId: string;
+  venueCollectionId: string;
+  artistCollectionId: string;
+  organizationCollectionId: string;
+  eventTypeCollectionId: string;
+  previewUrl: string;
+  domains: IWebFlowSiteDomain[];
+  createdAt: number;
+  updatedAt?: number;
+}
+
+export default interface IWebFlow {
+  _id?: string;
+  orgId: string;
+  sites?: IWebFlowSite[];
+  entities?: IWebFlowEntity[];
+  createdAt: number;
+  updatedAt?: number;
+}