@sellout/models 0.0.58 → 0.0.60

package/src/interfaces/IEventCustomField.ts

@@ -5,7 +5,7 @@ export enum EventCustomFieldTypeEnum {
   Dropdown = 'Dropdown',
 }
 
-export default interface IEventCustomFields {
+export default interface IEventCustomField {
   _id?: string;
   label?: string;
   type: EventCustomFieldTypeEnum;

package/src/interfaces/IEventUpgrade.ts

@@ -17,4 +17,5 @@ export default interface IEventUpgrade {
   imageUrl: string;
   description: string;
   visible: boolean;
+  rollFees: boolean;
 }

package/src/interfaces/IFee.ts

@@ -1,7 +1,6 @@
 export enum FeeTypeEnum {
   Flat = 'Flat',
   Percent = 'Percent',
-  // FlatPlusPercent = 'Flat + Percent',
 }
 
 export enum FeeAppliedToEnum {
@@ -16,11 +15,10 @@ export enum FeeAppliedByEnum {
   Organization = 'Organization',
 }
 
-export enum FeeFilters {
-  // Online = 'Online Orders Only',
-  // BoxOffice = 'Box Office Orders Only',
+export enum FeeFiltersEnum {
   Seated = 'Seated',
-  // FirstOrder = 'FirstOrder',
+  CardEntry = 'Card Entry',
+  CardReader = 'Card Reader',
 }
 
 export default interface IFee {
@@ -34,7 +32,7 @@ export default interface IFee {
   appliedBy: FeeAppliedByEnum;
   minAppliedToPrice?: number;
   maxAppliedToPrice?: number;
-  filters?: FeeFilters[];
+  filters?: FeeFiltersEnum[];
   createdBy?: string;
   createdAt?: number;
   updatedBy?: string;

package/src/interfaces/IOrder.ts

@@ -1,9 +1,11 @@
 import IAddress from "./IAddress";
+import IPayment from './IPayment';
 import IOrderTicket from './IOrderTicket';
 import IOrderUpgrade from './IOrderUpgrade';
 import IOrderCustomField from './IOrderCustomField'
 import { OrderStateEnum } from './IOrderState';
 import { OrderTypeEnum } from './IOrderType';
+import { OrderDeliveryMethodEnum } from "../enums/OrderDeliveryMethodEnum";
 
 export default interface IOrder {
   _id?: string;
@@ -14,14 +16,14 @@ export default interface IOrder {
   eventName: string;
   venueIds: string[];
   artistIds: string[];
-  feeIds: string[];
-  stripeChargeId?: string;
+  feeIds: string[]; // BACKFILL
+  stripeChargeId?: string; // BACKFILL
   tickets: IOrderTicket[];
   upgrades: IOrderUpgrade[];
   recipientEmails?: string[];
   qrCodeUrl?: string;
   state?: OrderStateEnum,
-  refundedAmount?: number;
+  refundedAmount?: number; // BACKFILL
   type?: OrderTypeEnum;
   createdAt?: number;
   createdBy?: string;
@@ -29,5 +31,7 @@ export default interface IOrder {
   ipAddress?: string;
   address?: IAddress;
   customFields?: IOrderCustomField[];
-  refundReason?: string;
+  refundReason?: string; // BACKFILL
+  payments: IPayment[];
+  deliveryMethod: OrderDeliveryMethodEnum,
 };

package/src/interfaces/IOrderState.ts

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

package/src/interfaces/IOrderTicket.ts

@@ -8,6 +8,8 @@ export default interface IOrderTicket {
   ticketTypeId: string;
   ticketTierId: string;
   price: number;
+  rollFees: boolean;
+  paymentId: string | null;
   seat: string;
   refund: IRefund;
   scan: IScan;

package/src/interfaces/IOrderType.ts

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

package/src/interfaces/IOrderUpgrade.ts

@@ -7,7 +7,8 @@ export default interface IOrderUpgrade {
   name: string;
   upgradeId: string;
   price: number;
-  total: number;
+  rollFees: boolean;
+  paymentId: string | null;
   refund: IRefund;
   scan: IScan;
   state: OrderItemStateEnum;

package/src/interfaces/IPagination.ts

@@ -2,3 +2,14 @@ export default interface IPagination {
   pageSize: number;
   pageNumber: number;
 }
+
+export enum PaginationTypes {
+  Orders = 'Orders',
+  EventOrders = 'EventOrders',
+  CustomerOrders = 'CustomerOrders',
+  Events = 'Events',
+  Artists = 'Artists',
+  Venues = 'Venues',
+}
+
+export type PaginationMap = Map<PaginationTypes, IPagination>;

package/src/interfaces/IPayment.ts

@@ -0,0 +1,13 @@
+import { PaymentMethodTypeEnum } from '../enums/PaymentMethodTypeEnum';
+export default interface IPayment {
+  _id?: string;
+  paymentIntentId?: string;
+  amount: number;
+  transferAmount: number;
+  feeAmount: number;
+  feeIds: string[];
+  createdAt: number;
+  createdBy: string;
+  promotionCode?: string;
+  paymentMethodType: PaymentMethodTypeEnum
+}

package/src/interfaces/IRole.ts

@@ -1,10 +1,3 @@
-export declare enum Roles {
-  OWNER = 'OWNER',
-  ADMIN = 'ADMIN',
-  BOX_OFFICE = 'BOX_OFFICE',
-  SCANNER = 'SCANNER',
-}
-
 export default interface IRole {
   _id?: string;
   orgId: string;
@@ -12,6 +5,31 @@ export default interface IRole {
   userEmail: string;
   createdAt: number;
   createdBy: string;
-  role: Roles;
+  role: RolesEnum;
   acceptedAt?: number;
 }
+
+// BACKFILL
+export enum RolesEnum {
+  SUPER_USER = 'SUPER_USER',
+  OWNER = 'OWNER',
+  ADMIN = 'ADMIN',
+  BOX_OFFICE = 'BOX_OFFICE',
+  SCANNER = 'SCANNER',
+}
+
+export const roleValues = {
+  [RolesEnum.SUPER_USER]: 4,
+  [RolesEnum.OWNER]: 3,
+  [RolesEnum.ADMIN]: 2,
+  [RolesEnum.BOX_OFFICE]: 1,
+  [RolesEnum.SCANNER]: 0,
+};
+
+// export enum RoleOrdinalEnum {
+//   SCANNER = 0,
+//   BOX_OFFICE,
+//   ADMIN,
+//   OWNER,
+//   SUPER_USER,
+// }

package/src/interfaces/IStripeCustomer.ts

@@ -0,0 +1,7 @@
+import IStripeSource from './IStripeSource';
+
+export default interface IStripeCustomer {
+  stripeCustomerId: string;
+  email: string;
+  sources: IStripeSource[];
+}

package/src/interfaces/IStripeSource.ts

@@ -0,0 +1,10 @@
+export default interface IStripeSource {
+  sourceId: string;
+  brand: string;
+  last4: string;
+  expMonth: string;
+  expYear: string;
+  funding: string;
+  country: string;
+  type : string;
+}

package/src/interfaces/IStripeTerminalReader.ts

@@ -0,0 +1,9 @@
+export default interface IStripeTerminalReader {
+  id: string;
+  label: string;
+  type: string;
+  location: string;
+  serialNumber: string;
+  status: string;
+  ipAddress: string;
+}

package/src/interfaces/ITicketTier.ts

@@ -2,8 +2,8 @@ export default interface ITicketTier {
   _id?: string;
   name: string;
   price: number;
-  startsAt: number;
-  endsAt: number;
+  startsAt: number | null;
+  endsAt: number | null;
   totalQty: number;
   remainingQty: number;
 }

package/src/interfaces/ITicketType.ts

@@ -10,4 +10,5 @@ export default interface ITicketType {
   performanceIds: string[];
   tiers: ITicketTier[];
   description?: string;
+  rollFees: boolean;
 }

package/src/interfaces/IUserProfile.ts

@@ -1,5 +1,6 @@
 import IAddress from "./IAddress";
-import IMetrics from "./IMetrics";
+import IStripeCustomer from './IStripeCustomer';
+import IUser from "./IUser";
 
 export default interface IUserProfile {
   _id?: string;
@@ -11,10 +12,15 @@ export default interface IUserProfile {
   authyId?: string;
   stripeCustomerId?: string;
   imageUrl?: string;
-  metrics?: IMetrics[];
   orgIds?: string[];
   eventIds?: string[];
   venueIds?: string[];
   artistIds?: string[];
   address?: IAddress;
 }
+
+
+export interface IUserProfileGraphQL extends IUserProfile {
+  user: IUser;
+  stripeCustomer: IStripeCustomer;
+}

package/src/interfaces/IVenue.ts

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

package/src/proto/artist.proto

@@ -13,8 +13,7 @@ message Artist {
   repeated ArtistPressKit pressKits = 7;
   repeated ArtistContact contacts = 8;
   string artistGlobalId = 9;
-  Metrics metrics = 10;
-  int32 createdAt = 11;
+  int32 createdAt = 10;
 }
 
 message SocialAccountLink {

package/src/proto/broadcast.proto

@@ -12,19 +12,6 @@ package Broadcast;
 message OrderCreatedNotification {
   string spanContext = 0;
   Order order = 1;
-  string orderId = 2;
-  string userId = 3;
-  string eventId = 4;
-  string orgId = 5;
-  repeated string venueIds = 6;
-  repeated string artistIds = 7;
-  int32 orderTotal = 8;
-  int32 transferAmount = 9;
-  int32 feeAmount = 10;
-  repeated Ticket tickets = 11;
-  repeated Upgrade upgrades = 12;
-  repeated TicketType ticketTypes = 13;
-  repeated UpgradeType upgradeTypes = 14;
 }
 
 message OrderRefundedNotification {

package/src/proto/common.proto

@@ -57,3 +57,18 @@ message Metrics {
   int32 lifeTimeOrdersComped = 26;
   int32 yearToDateOrdersComped = 27;
 }
+
+message Coordinates {
+  double x = 0;
+  double y = 1;
+}
+
+message Analytics {
+  string label = 0;
+  string interval = 1;
+  repeated string intervalOptions = 2;
+  repeated Coordinates coordinates = 3;
+  repeated Analytics segments = 4;
+  string type = 5;
+  double totalValue = 6;
+}

package/src/proto/event.proto

@@ -68,6 +68,7 @@ message TicketType {
   repeated TicketTier tiers = 7;
   bool visible = 8;
   string description = 9;
+  bool rollFees = 10;
 }
 
 message TicketTier {
@@ -101,6 +102,7 @@ message EventUpgrade {
   string imageUrl = 10;
   string description = 11;
   bool visible = 12;
+  bool rollFees = 13;
 }
 
 message EventPromotion {

package/src/proto/fee.proto

@@ -170,6 +170,20 @@ message DeletePlatformFeeResponse {
   repeated Error errors = 1;
 }
 
+/****************************************************************************************
+Apply Platform Fees
+****************************************************************************************/
+message ApplyPlatformFeesToAllOrganizationsRequest {
+  string spanContext = 0;
+}
+
+message ApplyPlatformFeesToAllOrganizationsResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  bool success = 2;
+}
+
+
 
 service FeeService {
   // Create
@@ -192,5 +206,7 @@ service FeeService {
   rpc disableFee(DisableFeeRequest) returns (DisableFeeResponse) {}
   rpc deleteOrganizationFee(DeleteOrganizationFeeRequest) returns (DeleteOrganizationFeeResponse) {}
   rpc deletePlatformFee(DeletePlatformFeeRequest) returns (DeletePlatformFeeResponse) {}
+  // Apply Platform Fees
+  rpc applyPlatformFeesToAllOrganizations(ApplyPlatformFeesToAllOrganizationsRequest) returns (ApplyPlatformFeesToAllOrganizationsResponse) {}
   
 }

package/src/proto/order.proto

@@ -31,6 +31,8 @@ message Order {
   Address address = 20;
   repeated OrderCustomField customFields = 21;
   string refundReason = 22;
+  repeated Payment payments = 23;
+  string deliveryMethod = 24;
 }
 
 message OrderTicket {
@@ -39,6 +41,8 @@ message OrderTicket {
   string ticketTypeId = 2;
   string ticketTierId = 3;
   int32 price = 4;
+  bool rollFees = 5;
+  string paymentId = 6;
   string seat = 7;
   Refund refund = 8;
   Scan scan = 9;
@@ -50,6 +54,8 @@ message OrderUpgrade {
   string name = 1;
   string upgradeId = 2;
   int32 price = 3;
+  bool rollFees = 4;
+  string paymentId = 5;
   Refund refund = 6;
   Scan scan = 7;
   string state = 8;
@@ -76,22 +82,64 @@ message OrderCustomField {
   string type = 4;
 }
 
+message Payment {
+  string _id = 0;
+  string paymentIntentId = 1;
+  int32 amount = 2;
+  int32 transferAmount = 3;
+  int32 feeAmount = 4;
+  string feeIds = 5;
+  int32 createdAt = 6;
+  string createdBy = 7;
+  string promotionCode = 8;
+  string paymentMethodType = 9;
+}
+
 /****************************************************************************************
   Create Order
 ****************************************************************************************/
 
+message CreateOrderParams {
+  string userId = 0;
+  string orgId = 1;
+  string eventId = 2;
+  repeated CreateOrderTicketParams tickets = 3;
+  repeated CreateOrderUpgradeParams upgrades = 4;
+  string type = 5;
+  string promotionCode = 6;
+  repeated OrderCustomField customFields = 7;
+  string deliveryMethod = 8;
+  string paymentMethodType = 9;
+  string holdToken = 10;
+  string ipAddress = 11;
+}
+
+message CreateOrderTicketParams {
+  string name = 0;
+  string ticketTypeId = 1;
+  string ticketTierId = 2;
+  int32 price = 3;
+  bool rollFees = 4;
+}
+
+message CreateOrderUpgradeParams {
+  string name = 0;
+  string upgradeId = 1;
+  int32 price = 2;
+  bool rollFees = 3;
+}
+
 message CreateOrderRequest {
   string spanContext = 0;
   string requestorId = 1;
-  Order order = 2;
-  string stripeToken = 3;
-  string holdToken = 4;
+  CreateOrderParams params = 2;
 }
 
 message CreateOrderResponse {
   StatusCode status = 1;
   repeated Error errors = 2;
   Order order = 3;
+  string clientSecret = 4;
 }
 
 /****************************************************************************************
@@ -175,7 +223,7 @@ message ScanOrderRequest {
   string orderId = 1;
   repeated string ticketIds = 2;
   repeated string upgradeIds = 3;
-  string scannedBy  = 4;
+  string scannedBy = 4;
 }
 
 message ScanOrderResponse {
@@ -253,6 +301,31 @@ message FindOrderByEmailResponse {
   Order order = 2;
 }
 
+/****************************************************************************************
+  Query Order Analytics
+****************************************************************************************/
+
+message OrderAnalyticsQuery {
+  string eventId = 0;
+  string venueId = 1;
+  string artistId = 2;
+  int32 startDate = 3;
+  int32 endDate = 4;
+  string interval = 5;
+  repeated string types = 6;
+}
+
+message QueryOrderAnalyticsRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  OrderAnalyticsQuery query = 2;
+}
+
+message QueryOrderAnalyticsResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  repeated Analytics analytics = 2;
+}
 
 service OrderService {
   // Create
@@ -271,5 +344,6 @@ service OrderService {
   rpc queryOrders(QueryOrdersRequest) returns (QueryOrdersResponse) {}
   rpc findOrderById(FindOrderByIdRequest) returns (FindOrderByIdResponse) {}
   rpc findOrderByEmail(FindOrderByEmailRequest) returns (FindOrderByEmailResponse) {}
+  rpc queryOrderAnalytics(QueryOrderAnalyticsRequest) returns (QueryOrderAnalyticsResponse) {}
   
 }