@sellout/models 0.0.1

package/src/proto/order.proto

@@ -0,0 +1,272 @@
+syntax = "proto3";
+
+import "error.proto";
+import "common.proto";
+
+/****************************************************************************************
+  Order Models
+****************************************************************************************/
+
+message Order {
+  string _id = 0;
+  string orgId = 1;
+  string userId = 2;
+  string eventId = 3;
+  string eventName = 4;
+  repeated string venueIds = 5;
+  repeated string artistIds = 6;
+  repeated string feeIds = 7;
+  int32 createdAt = 8;
+  string stripeChargeId = 9;
+  repeated OrderTicket tickets = 10;
+  repeated OrderUpgrade upgrades = 11;
+  repeated string recipientEmails = 12;
+  string qrCodeUrl = 13;
+  string state = 14;
+  int32 refundedAmount = 15;
+  string type = 16;
+  string createdBy = 17;
+  string promotionCode = 18;
+  string ipAddress = 19;
+  Address address = 20;
+  repeated OrderCustomField customFields = 21;
+}
+
+message OrderTicket {
+  string _id = 0;
+  string name = 1;
+  string ticketTypeId = 2;
+  string ticketTierId = 3;
+  int32 price = 4;
+  string seat = 7;
+  Refund refund = 8;
+  Scan scan = 9;
+  string state = 10;
+}
+
+message OrderUpgrade {
+  string _id = 0;
+  string name = 1;
+  string upgradeId = 2;
+  int32 price = 3;
+  Refund refund = 6;
+  Scan scan = 7;
+  string state = 8;
+}
+
+message Scan {
+  bool scanned = 0;
+  int32 scannedAt = 1;
+  string scannedBy = 2;
+}
+
+message Refund {
+  bool refunded = 0;
+  int32 refundedAt = 1;
+  string refundedBy = 2;
+  int32 refundedAmount = 3;
+}
+
+message OrderCustomField {
+  string _id = 0;
+  string label = 1;
+  string value = 2;
+  string customFieldId = 3;
+  string type = 4;
+}
+
+/****************************************************************************************
+  Create Order
+****************************************************************************************/
+
+message CreateOrderRequest {
+  string spanContext = 0;
+  string requestorId = 1;
+  Order order = 2;
+  string stripeToken = 3;
+  string holdToken = 4;
+}
+
+message CreateOrderResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  Order order = 3;
+}
+
+/****************************************************************************************
+  Refund Order
+****************************************************************************************/
+
+message RefundOrderRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string orderId = 2;
+  int32 refundAmount = 3;
+  repeated string ticketIds = 4;
+  repeated string upgradeIds = 5;
+  string refundedBy = 6;
+}
+
+message RefundOrderResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  Order order = 3;
+}
+
+message RefundEventOrdersRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string eventId = 2;
+  string refundedBy = 3;
+  bool dryRun = 4;
+}
+
+message RefundEventOrdersResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  bool allRefunded = 2;
+  int32 refundCount = 3;
+  int32 refundAmount = 4;
+  int32 feeAmount = 5;
+  bool dryRun = 6;
+}
+
+/****************************************************************************************
+  QR Code
+****************************************************************************************/
+
+// TODO add orgId to these requests
+
+message SendOrderReceiptEmailRequest {
+  string spanContext = 0;
+  string orderId = 1;
+}
+
+message SendOrderReceiptEmailResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+message SendOrderQRCodeEmailRequest {
+  string spanContext = 0;
+  string orderId = 1;
+}
+
+message SendOrderQRCodeEmailResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+message SendOrderRefundEmailRequest {
+  string spanContext = 0;
+  string orderId = 1;
+}
+
+message SendOrderRefundEmailResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+message ScanOrderRequest {
+  string spanContext = 0;
+  string orderId = 1;
+  repeated string ticketIds = 2;
+  repeated string upgradeIds = 3;
+  string scannedBy  = 4;
+}
+
+message ScanOrderResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Order order = 2;
+}
+
+/****************************************************************************************
+  Order Report
+****************************************************************************************/
+
+message GenerateOrderReportRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  OrderQuery query = 2;
+}
+
+message GenerateOrderReportResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  string url = 2;
+}
+
+/****************************************************************************************
+  Find Order
+****************************************************************************************/
+
+message OrderQuery {
+  repeated string orderIds = 0;
+  repeated string eventIds = 1;
+  repeated string venueIds = 2; 
+  repeated string artistIds = 3;
+  repeated string userIds = 4;
+  repeated string states = 5;
+  repeated string types = 6;
+  string userQuery = 7;
+  int32 startDate = 8;
+  int32 endDate = 9;
+  bool any = 10;
+}
+
+message QueryOrdersRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  OrderQuery query = 2;
+  Pagination pagination = 3;
+}
+
+message QueryOrdersResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  repeated Order orders = 3;
+}
+
+message FindOrderByIdRequest {
+  string spanContext = 0;
+  string orderId = 1;
+}
+
+message FindOrderByIdResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Order order = 2;
+}
+
+message FindOrderByEmailRequest {
+  string spanContext = 0;
+  string email = 1;
+}
+
+message FindOrderByEmailResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Order order = 2;
+}
+
+
+service OrderService {
+  // Create
+  rpc createOrder(CreateOrderRequest) returns (CreateOrderResponse) {}
+  // QR Code
+  rpc sendOrderQRCodeEmail(SendOrderQRCodeEmailRequest) returns (SendOrderQRCodeEmailResponse) {}
+  rpc sendOrderReceiptEmail(SendOrderReceiptEmailRequest) returns (SendOrderReceiptEmailResponse) {}
+  rpc sendOrderRefundEmail(SendOrderRefundEmailRequest) returns (SendOrderRefundEmailResponse) {}
+  rpc scanOrder(ScanOrderRequest) returns (ScanOrderResponse) {}
+  // Refund
+  rpc refundOrder(RefundOrderRequest) returns (RefundOrderResponse) {}
+  rpc refundEventOrders(RefundEventOrdersRequest) returns (RefundEventOrdersResponse) {}
+  // Report
+  rpc generateOrderReport(GenerateOrderReportRequest) returns (GenerateOrderReportResponse) {}
+  // Find
+  rpc queryOrders(QueryOrdersRequest) returns (QueryOrdersResponse) {}
+  rpc findOrderById(FindOrderByIdRequest) returns (FindOrderByIdResponse) {}
+  rpc findOrderByEmail(FindOrderByEmailRequest) returns (FindOrderByEmailResponse) {}
+  
+}

package/src/proto/organization.proto

@@ -0,0 +1,107 @@
+syntax = "proto3";
+
+import "error.proto";
+import "common.proto";
+
+message Organization {
+  string _id = 0;
+  string userId = 1;
+  int32 createdAt = 2;
+  string authyId = 3;
+  string stripeId = 4;
+  string orgName = 5;
+  repeated string orgUrls = 6;
+  Address address = 7;
+  string orgLogoUrl = 8;
+  string orgColorHex = 9;
+  string bio = 10;
+  string email = 11;
+  string phoneNumber = 12;
+  string facebookPixelId = 13;
+  string googleAnalyticsId = 14;
+}
+
+// Create Organization
+message CreateOrganizationRequest {
+  string spanContext = 0;
+  string userId = 1;
+}
+
+message CreateOrganizationResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Organization organization = 3;
+}
+
+// List OrgUrls
+message ListOrganizationUrlsRequest {
+  string spanContext = 0;
+}
+
+message ListOrganizationUrlsResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  repeated string orgUrls = 2;
+}
+
+// Update Organization
+message UpdateOrganizationRequest {
+  string spanContext = 0;
+  Organization organization = 1;
+  string orgId = 2;
+}
+
+message UpdateOrganizationResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Organization organization = 2;
+}
+
+/****************************************************************************************
+  Find Organizations
+****************************************************************************************/
+
+message OrganizationQuery {
+  string name = 0;
+  repeated string orgIds = 1; 
+  int32 startDate = 2;
+  int32 endDate = 3;
+  bool any = 4;
+}
+
+message QueryOrganizationsRequest {
+  string spanContext = 0;
+  OrganizationQuery query = 1;
+  Pagination pagination = 2;
+}
+
+message QueryOrganizationsResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  repeated Organization organizations = 2;
+}
+
+// Find Organization
+message FindOrganizationRequest {
+  string spanContext = 0;
+  string orgId = 1;
+}
+
+message FindOrganizationResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Organization organization = 2;
+}
+
+service OrganizationService {
+  // Create
+  rpc createOrganization(CreateOrganizationRequest) returns (CreateOrganizationResponse) {}
+  // List
+  rpc listOrganizationUrls(ListOrganizationUrlsRequest) returns (ListOrganizationUrlsResponse) {}
+  // Query
+  rpc queryOrganizations(QueryOrganizationsRequest) returns (QueryOrganizationsResponse) {}
+  // Update
+  rpc updateOrganization(UpdateOrganizationRequest) returns (UpdateOrganizationResponse) {}
+  // Find
+  rpc findOrganization(FindOrganizationRequest) returns (FindOrganizationResponse) {}  
+}

package/src/proto/role.proto

@@ -0,0 +1,136 @@
+syntax = "proto3";
+
+import "error.proto";
+import "common.proto";
+
+
+message Role {
+  string _id = 0;
+  string orgId = 1;
+  string userId = 2;
+  string userEmail = 3;
+  int32 createdAt = 4;
+  string createdBy = 5;
+  string role = 6;
+  int32 acceptedAt = 7;
+}
+
+/****************************************************************************************
+Create Role
+****************************************************************************************/
+message CreateRoleRequest {
+  string spanContext = 0;
+  Role role = 1;
+  string creatorId = 2;
+}
+
+message CreateRoleResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Role role = 2;
+}
+
+/****************************************************************************************
+Delete Role
+****************************************************************************************/
+message DeleteRoleRequest {
+  string spanContext = 0;
+  string roleId = 2;
+}
+
+message DeleteRoleResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+/****************************************************************************************
+Accept Role
+****************************************************************************************/
+message AcceptRoleRequest {
+  string spanContext = 0;
+  string roleId = 1;
+  bool accept = 2;
+}
+
+message AcceptRoleResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Role role = 2;
+}
+
+/****************************************************************************************
+Assign UserId 
+****************************************************************************************/
+
+message AssignUserIdToRolesRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string userEmail = 2;
+}
+
+message AssignUserIdToRolesResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+/****************************************************************************************
+Find Role
+****************************************************************************************/
+message FindRoleByIdRequest {
+  string spanContext = 0;
+  string roleId = 1;
+}
+
+message FindRoleByIdResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Role role = 2;
+}
+
+/****************************************************************************************
+Find User Role
+****************************************************************************************/
+message FindUserRoleRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string orgId = 2;
+}
+
+message FindUserRoleResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Role role = 2;
+}
+
+/****************************************************************************************
+Query Roles
+****************************************************************************************/
+message QueryRolesRequest {
+  string spanContext = 0;
+  repeated Query query  = 1;
+  Pagination pagination = 2;
+}
+
+message QueryRolesResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  repeated Role roles = 2;
+}
+
+
+
+service RoleService {
+  // Create
+  rpc createRole(CreateRoleRequest) returns (CreateRoleResponse) {}
+  // Delete
+  rpc deleteRole(DeleteRoleRequest) returns (DeleteRoleResponse) {}
+  // Accept
+  rpc acceptRole(AcceptRoleRequest) returns (AcceptRoleResponse) {}  
+  // Assign UserId
+  rpc assignUserIdToRoles(AssignUserIdToRolesRequest) returns (AssignUserIdToRolesResponse) {}  
+  // Find
+  rpc findRoleById(FindRoleByIdRequest) returns (FindRoleByIdResponse) {}  
+  rpc findUserRole(FindUserRoleRequest) returns (FindUserRoleResponse) {}  
+  // List
+  rpc queryRoles(QueryRolesRequest) returns (QueryRolesResponse) {}
+}

package/src/proto/seating.proto

@@ -0,0 +1,64 @@
+syntax = "proto3";
+
+import "error.proto";
+import "common.proto";
+
+/***************************************************************************************
+  Seating Models
+****************************************************************************************/
+
+message Seating {
+  string _id = 0;
+  string orgId = 1;
+  string publicKey = 2;
+  string secretKey = 3;
+  string designerKey = 4;
+  int32 createdAt = 5;
+  int32 updatedAt = 6;
+}
+
+/***************************************************************************************
+  Seating
+****************************************************************************************/
+
+message CreateSeatingRequest {
+  string spanContext = 0;
+  string orgId = 1;
+}
+
+message CreateSeatingResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Seating seating = 2;
+}
+
+message BookSeatsRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string eventId = 2;
+  string holdToken = 3;
+  repeated string seats = 4;
+}
+
+message BookSeatsResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+message FindOrganizationSeatingRequest {
+  string spanContext = 0;
+  string orgId = 1;
+}
+
+message FindOrganizationSeatingResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  Seating seating = 2;
+}
+
+service SeatingService {
+  // Seating
+  rpc createSeating(CreateSeatingRequest) returns (CreateSeatingResponse) {}
+  rpc bookSeats(BookSeatsRequest) returns (BookSeatsResponse) {}
+  rpc findOrganizationSeating(FindOrganizationSeatingRequest) returns (FindOrganizationSeatingResponse) {}
+}