@sellout/models 0.0.1

package/src/proto/artist.proto

@@ -0,0 +1,156 @@
+syntax = "proto3";
+
+import "error.proto";
+import "common.proto";
+
+message Artist {
+  string _id = 1;
+  string name = 2;
+  repeated string genres = 3;
+  repeated SocialAccountLink socialAccounts = 4;
+  repeated ArtistPressKit pressKits = 5;
+  repeated ArtistContact contacts = 6;
+  string artistGlobalId = 7;
+  string orgId = 8;
+  Metrics metrics = 9;
+}
+
+message SocialAccountLink {
+  string _id = 0;
+  string platform = 1;
+  string link = 2;
+}
+
+message ArtistPressKit {
+  string _id = 0;
+  string title = 1;
+  string description = 2;
+  repeated string posterImageUrls = 3;
+  repeated SocialAccountLink links = 4;
+}
+
+message ArtistContact {
+  string _id = 0;
+  string firstName = 1;
+  string lastName = 2;
+  string title = 3;
+  string company = 4;
+  string email = 5;
+  string phoneNumber = 6;
+}
+
+
+// Create Artist
+message CreateArtistRequest {
+  string spanContext = 0;
+  Artist artist = 1;
+  string orgId = 2;
+}
+
+message CreateArtistResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  Artist artist = 3;
+}
+
+// Update Artist
+message UpdateArtistRequest {
+  string spanContext = 1;
+  Artist artist = 2;
+  string orgId = 3;
+  
+}
+
+message UpdateArtistResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  Artist artist = 3;
+}
+
+/****************************************************************************************
+  Find Artist
+****************************************************************************************/
+
+message ArtistQuery {
+  string name = 0;
+  repeated string artistIds = 1;
+  bool any = 2;
+}
+
+message QueryArtistsRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  ArtistQuery query = 2;
+  Pagination pagination = 3;
+}
+
+message QueryArtistsResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  repeated Artist artists = 2;
+}
+
+// Find Artist
+
+message FindArtistByIdRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string artistId = 2;
+}
+
+message FindArtistByIdResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  Artist artist = 3;
+}
+
+// List Artists By Id
+message ListArtistsByIdRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  repeated string artistIds = 2;
+}
+
+message ListArtistsByIdResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  repeated Artist artists = 3;
+}
+
+// List Artists
+message ListArtistsRequest {
+  string spanContext = 0;
+  string orgId = 1;
+}
+
+message ListArtistsResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  repeated Artist artists = 3;
+}
+
+message QueryGlobalArtistsRequest {
+  string spanContext = 0;
+  repeated Query query = 1;
+  Pagination pagination = 2; 
+}
+
+message QueryGlobalArtistsResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  repeated Artist artists = 3;
+}
+
+service ArtistService {
+  // Create
+  rpc createArtist(CreateArtistRequest) returns (CreateArtistResponse) {}
+  // Update
+  rpc updateArtist(UpdateArtistRequest) returns (UpdateArtistResponse) {}
+  // Find
+  rpc findArtistById(FindArtistByIdRequest) returns (FindArtistByIdResponse) {} 
+  // List
+  rpc queryArtists(QueryArtistsRequest) returns (QueryArtistsResponse) {}
+  rpc listArtists(ListArtistsRequest) returns (ListArtistsResponse) {}
+  rpc listArtistsById(ListArtistsByIdRequest) returns (ListArtistsByIdResponse) {}
+  rpc queryGlobalArtists(QueryGlobalArtistsRequest) returns (QueryGlobalArtistsResponse) {}
+}

package/src/proto/broadcast.proto

@@ -0,0 +1,157 @@
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+import "order.proto";
+
+package Broadcast;
+
+/****************************************************************************************
+* Order
+*****************************************************************************************/
+
+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 {
+  string spanContext = 0;
+  Order order = 1;
+  string orgId = 2;
+  string userId = 3;
+  string orderId = 4;
+  string eventId = 5;
+  repeated string venueIds = 6;
+  repeated string artistIds = 7;
+  int32 refundAmount = 8;
+  int32 totalRefundedAmount = 9;
+  bool isFullyRefunded = 10;
+  bool isFullyCanceled = 11;
+  repeated string refundedTickets = 12;
+  repeated string refundedUpgrades = 13;
+}
+
+message Ticket {
+  string ticketId = 0;
+  int32 qty = 1;
+}
+
+message Upgrade {
+  string upgradeId = 0;
+  int32 qty = 1;
+}
+
+message TicketType {
+  string ticketTypeId = 0;
+  string ticketTierId = 1;
+  int32 qty = 2;
+}
+
+message UpgradeType {
+  string upgradeTypeId = 0;
+  int32 qty = 1;
+}
+
+
+/****************************************************************************************
+* Event
+*****************************************************************************************/
+
+message EventCreatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+  string eventId = 2;
+}
+
+message EventPublishedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+  string eventId = 2;
+}
+
+message EventUpdatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+  string eventId = 2;
+}
+
+/****************************************************************************************
+* Organization
+*****************************************************************************************/
+
+message OrganizationCreatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+}
+
+message OrganizationUpdatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+}
+
+/****************************************************************************************
+* Venue
+*****************************************************************************************/
+
+message VenueCreatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+  string venueId = 2;
+}
+
+message VenueUpdatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+  string venueId = 2;
+}
+
+
+
+/****************************************************************************************
+* Artist
+*****************************************************************************************/
+
+message ArtistCreatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+  string artistId = 2;
+}
+
+message ArtistUpdatedNotification {
+  string spanContext = 0;
+  string orgId = 1;
+  string artistId = 2;
+}
+
+service Publisher {
+  // Order
+  rpc orderCreated(OrderCreatedNotification) returns (google.protobuf.Empty) {}
+  rpc orderRefunded(OrderRefundedNotification) returns (google.protobuf.Empty) {}
+  // Event
+  rpc eventCreated(EventCreatedNotification) returns (google.protobuf.Empty) {}
+  rpc eventPublished(EventPublishedNotification) returns (google.protobuf.Empty) {}
+  rpc eventUpdated(EventUpdatedNotification) returns (google.protobuf.Empty) {}
+  // Organization
+  rpc organizationCreated(OrganizationCreatedNotification) returns (google.protobuf.Empty) {}
+  rpc organizationUpdated(OrganizationUpdatedNotification) returns (google.protobuf.Empty) {}
+  // Venue
+  rpc venueCreated(VenueCreatedNotification) returns (google.protobuf.Empty) {}
+  rpc venueUpdated(VenueUpdatedNotification) returns (google.protobuf.Empty) {}
+  // Artist
+  rpc artistCreated(ArtistCreatedNotification) returns (google.protobuf.Empty) {}
+  rpc artistUpdated(ArtistUpdatedNotification) returns (google.protobuf.Empty) {}
+
+}

package/src/proto/common.proto

@@ -0,0 +1,59 @@
+syntax = "proto3";
+
+message Address {
+  string address1 = 1;
+  string address2 = 2;
+  string city = 3;
+  string state = 4;
+  string zip = 5;
+  string country = 6;
+  string phone = 7;
+  double lat = 8;
+  double lng = 9;
+  string placeId = 10;
+  string timezone = 11;
+}
+
+message Query {
+  string key = 1;
+  string value = 2;
+}
+
+message Pagination {
+  int32 pageSize = 1;
+  int32 pageNumber = 2;
+}
+
+message Metrics {
+  string _id = 1;
+  string orgId  = 2;
+  int32 createdAt = 3;
+  // Value
+  int32 lifeTimeValue = 4;
+  int32 yearToDateValue = 5;
+  int32 lifeTimeValueRefunded = 6;
+  int32 yearToDateValueRefunded = 7;
+  int32 lifeTimeValueComped = 8;
+  int32 yearToDateValueComped = 9;
+  // Tickets
+  int32 lifeTimeTicketsPurchased = 10;
+  int32 yearToDateTicketsPurchased = 11;
+  int32 lifeTimeTicketsRefunded = 12;
+  int32 yearToDateTicketsRefunded = 13;
+  int32 lifeTimeTicketsComped = 14;
+  int32 yearToDateTicketsComped = 15;
+  // Upgrades
+  int32 lifeTimeUpgradesPurchased = 16;
+  int32 yearToDateUpgradesPurchased = 17;
+  int32 lifeTimeUpgradesRefunded = 18;
+  int32 yearToDateUpgradesRefunded = 19;
+  int32 lifeTimeUpgradesComped = 20;
+  int32 yearToDateUpgradesComped = 21;
+  // Orders
+  int32 lifeTimeOrdersPurchased = 22;
+  int32 yearToDateOrdersPurchased = 23;
+  int32 lifeTimeOrdersRefunded = 24;
+  int32 yearToDateOrdersRefunded = 25;
+  int32 lifeTimeOrdersComped = 26;
+  int32 yearToDateOrdersComped = 27;
+}

package/src/proto/email.proto

@@ -0,0 +1,179 @@
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+/****************************************************************************************
+* User
+****************************************************************************************/
+
+message QueueUserWelcomeEmailRequest {
+  string spanContext = 0;
+  string toAddress = 1;
+  string firstName = 2;
+  string lastName = 3;
+  string verificationCode = 4;
+}
+
+message QueueUserResetPasswordEmailRequest {
+  string spanContext = 0;
+  string toAddress = 1;
+  string resetPasswordUrl = 4;
+}
+
+message QueueInviteToOrganizationEmailRequest {
+  string spanContext = 0;
+  string toAddress = 1;
+  string orgName = 2;
+  string redirectUrl = 3;
+  string orgLogo = 4;
+  string roleName = 5;
+}
+
+/****************************************************************************************
+  * Order
+****************************************************************************************/
+
+message OrderSummaryItem {
+  string name = 0;
+  string price = 1;
+  string fee = 2;
+  string seats = 3;
+}
+
+message OrderRefundItem {
+  string name = 0;
+  string refundedAmount = 1;
+}
+
+message QueueOrderReceiptEmailRequest {
+  string spanContext = 0;
+  string toAddress = 1;
+  string firstName = 2;
+  string eventName = 3;
+  string orgName = 4;
+  string eventSubtitle = 5;
+  string eventDate = 6;
+  string venueName = 7;
+  string doorsAt = 8;
+  string showAt = 9;
+  string qrCodeAt = 10;
+  string confirmationCode = 11;
+  string orgEmail = 12;
+  string orgPhoneNumber = 13;
+  string orgAddress1 = 14;
+  string orgAddress2 = 15;
+  string eventPosterImageUrl = 16;
+  string cityState = 17;
+  string orgLogoUrl = 18;
+  repeated OrderSummaryItem orderItems = 19;
+  string orderTotal = 20;
+  string venueAddress1 = 21;
+  string venueAddress2 = 22;
+  string orderFees = 23;
+  string orderSubtotal = 24;
+  string venuePosterImageUrl = 25;
+  bool isRSVP = 26;
+}
+
+message QueueOrderQRCodeEmailRequest {
+  string spanContext = 0;
+  string toAddress = 1;
+  string firstName = 2;
+  string eventName = 3;
+  string orgName = 4;
+  string eventSubtitle = 5;
+  string eventDate = 6;
+  string venueName = 7;
+  string doorsAt = 8;
+  string showAt = 9;
+  string qrCodeAt = 10;
+  string confirmationCode = 11;
+  string orgEmail = 12;
+  string orgPhoneNumber = 13;
+  string orgAddress1 = 14;
+  string orgAddress2 = 15;
+  string eventPosterImageUrl = 16;
+  string cityState = 17;
+  string orgLogoUrl = 18;
+  repeated OrderSummaryItem orderItems = 19;
+  string orderTotal = 20;
+  string qrCodeUrl = 21;
+  string venueAddress1 = 22;
+  string venueAddress2 = 23;
+  string orderFees = 24;
+  string orderSubtotal = 25;
+  string venuePosterImageUrl = 26;
+  bool isRSVP = 27;
+}
+
+message QueueOrderRefundEmailRequest {
+  string spanContext = 0;
+  string toAddress = 1;
+  string firstName = 2;
+  string eventName = 3;
+  string orgName = 4;
+  string eventSubtitle = 5;
+  string eventDate = 6;
+  string venueName = 7;
+  string doorsAt = 8;
+  string showAt = 9;
+  string qrCodeAt = 10;
+  string confirmationCode = 11;
+  string orgEmail = 12;
+  string orgPhoneNumber = 13;
+  string orgAddress1 = 14;
+  string orgAddress2 = 15;
+  string eventPosterImageUrl = 16;
+  string cityState = 17;
+  string orgLogoUrl = 18;
+  string venueAddress1 = 19;
+  string venueAddress2 = 20;
+  string venuePosterImageUrl = 21;
+  bool isRSVP = 22;
+  repeated OrderRefundItem orderRefundItems = 23;
+  string orderSubtotalRefunded = 24;
+  string orderFeesRefunded = 25;
+  string orderTotalRefunded = 26;
+}
+
+message QueueOrderCanceledEmailRequest {
+  string spanContext = 0;
+  string toAddress = 1;
+  string firstName = 2;
+  string eventName = 3;
+  string orgName = 4;
+  string eventSubtitle = 5;
+  string eventDate = 6;
+  string venueName = 7;
+  string doorsAt = 8;
+  string showAt = 9;
+  string qrCodeAt = 10;
+  string confirmationCode = 11;
+  string orgEmail = 12;
+  string orgPhoneNumber = 13;
+  string orgAddress1 = 14;
+  string orgAddress2 = 15;
+  string eventPosterImageUrl = 16;
+  string cityState = 17;
+  string orgLogoUrl = 18;
+  string venueAddress1 = 19;
+  string venueAddress2 = 20;
+  string venuePosterImageUrl = 21;
+  bool isRSVP = 22;
+  repeated OrderRefundItem orderRefundItems = 23;
+  string orderSubtotalRefunded = 24;
+  string orderFeesRefunded = 25;
+  string orderTotalRefunded = 26;
+}
+
+service EmailService {
+  // User
+  rpc queueUserWelcomeEmail (QueueUserWelcomeEmailRequest) returns (google.protobuf.Empty) {}
+  rpc queueUserResetPasswordEmail (QueueUserResetPasswordEmailRequest) returns (google.protobuf.Empty) {}
+  rpc queueInviteToOrganizationEmailRequest (QueueInviteToOrganizationEmailRequest) returns (google.protobuf.Empty) {}
+  // Order
+  rpc queueOrderReceiptEmail (QueueOrderReceiptEmailRequest) returns (google.protobuf.Empty) {}
+  rpc queueOrderQRCodeEmail (QueueOrderQRCodeEmailRequest) returns (google.protobuf.Empty) {}
+  rpc queueOrderRefundEmail (QueueOrderRefundEmailRequest) returns (google.protobuf.Empty) {}
+  rpc queueOrderCanceledEmail (QueueOrderCanceledEmailRequest) returns (google.protobuf.Empty) {}
+}

package/src/proto/error.proto

@@ -0,0 +1,31 @@
+syntax = "proto3";
+
+/*
+ * We leverage well-understood HTTP status codes to define the types of errors,
+ * which can occur across our upstream services.  These should be localized and translated
+ * before being displayed to end users.
+ *
+ */
+enum StatusCode {
+  UNKNOWN_CODE = 0;
+
+  OK = 200;
+
+  BAD_REQUEST = 400;
+  UNAUTHORIZED = 401;
+  FORBIDDEN = 403;
+  UNPROCESSABLE_ENTITY = 422;
+
+  INTERNAL_SERVER_ERROR = 500;
+  GATEWAY_TIMEOUT = 504;
+}
+
+/*
+ * Field-level error responses, i.e. { key: 'firstName', message: '"firstName" is required' }.
+ * Note, these messages eventually need to be symbolic, and also localized/translated.
+ * Right now, we're mainly using the English strings returned by the Joi validators.
+ */
+message Error {
+  string key = 1;
+  string message = 2;
+}