@sellout/models 0.0.1

package/src/proto/stripe.proto

@@ -0,0 +1,181 @@
+syntax = "proto3";
+
+import "error.proto";
+
+/***************************************************************************************
+  Stripe Models
+****************************************************************************************/
+
+message StripeConnectAccount {
+  string name = 0;
+  string country = 1;
+  string email = 2;
+  bool payoutsEnabled = 3;
+  string stripeAccountId = 4;
+}
+
+message StripeCharge {
+  string brand = 0;
+  string last4 = 1;
+}
+
+message StripeCustomer {
+  string stripeCustomerId = 0;
+  string email = 1;
+  repeated StripeSource sources = 2;
+}
+
+message StripeSource {
+  string sourceId = 0;
+  string brand = 1;
+  string last4 = 2;
+  string expMonth = 3;
+  string expYear = 4;
+  string funding = 5;
+  string country = 6;
+  string type = 7;
+}
+
+/***************************************************************************************
+  Connect Account
+****************************************************************************************/
+
+message ConnectStripeUserRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string connectCode = 2;  
+}
+
+message ConnectStripeUserResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+message RetrieveStripeConnectAccountRequest {
+  string spanContext = 0;
+  string stripeAccountId = 1;
+}
+
+message RetrieveStripeConnectAccountResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  StripeConnectAccount stripeConnectAccount = 2;
+}
+
+/***************************************************************************************
+  Charge
+****************************************************************************************/
+
+message CreateStripeChargeRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string userId = 2;
+  // The total amount being processed
+  // i.e. the order total, etc
+  int32 amount = 3;
+  // The amount the promoter will recieive
+  // (subtracts sellout and stripe fees)
+  int32 transferAmount = 4;
+  // Amount sellout takes as a fee
+  int32 feeAmount = 5;
+  string description = 6;
+  string stripeToken = 7;
+  string currency = 8;
+}
+
+message CreateStripeChargeResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  string stripeChargeId = 2;
+}
+
+message RefundStripeChargeRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string stripeChargeId = 2;
+  int32 amount = 3;
+}
+
+message RefundStripeChargeResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  string refundId = 2;
+}
+
+message RetrieveStripeChargeRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  string stripeChargeId = 2;
+}
+
+message RetrieveStripeChargeResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  StripeCharge stripeCharge = 2;
+}
+
+/***************************************************************************************
+  Customer
+****************************************************************************************/
+
+message CreateStripeCustomerRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string stripeToken = 2;
+}
+
+message CreateStripeCustomerResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  StripeCustomer stripeCustomer = 2;
+}
+
+message RetrieveStripeCustomerRequest {
+  string spanContext = 0;
+  string stripeCustomerId = 1;
+}
+
+message RetrieveStripeCustomerResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  StripeCustomer stripeCustomer = 2;
+}
+
+message CreateStripeSourceRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string stripeToken = 2;
+}
+
+message CreateStripeSourceResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  StripeCustomer stripeCustomer = 2;
+}
+
+message DeleteStripeSourceRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string sourceId = 2;
+}
+
+message DeleteStripeSourceResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+/***************************************************************************************
+  RPC
+****************************************************************************************/
+
+service StripeService {
+  rpc connectStripeUser(ConnectStripeUserRequest) returns (ConnectStripeUserResponse) {}
+  rpc retrieveStripeConnectAccount(RetrieveStripeConnectAccountRequest) returns (RetrieveStripeConnectAccountResponse) {}
+  rpc createStripeCharge(CreateStripeChargeRequest) returns (CreateStripeChargeResponse) {}
+  rpc refundStripeCharge(RefundStripeChargeRequest) returns (RefundStripeChargeResponse) {}
+  rpc retrieveStripeCharge(RetrieveStripeChargeRequest) returns (RetrieveStripeChargeResponse) {}
+  rpc createStripeCustomer(CreateStripeCustomerRequest) returns (CreateStripeCustomerResponse) {}
+  rpc retrieveStripeCustomer(RetrieveStripeCustomerRequest) returns (RetrieveStripeCustomerResponse) {}
+  rpc createStripeSource(CreateStripeSourceRequest) returns (CreateStripeSourceResponse) {}
+  rpc deleteStripeSource(DeleteStripeSourceRequest) returns (DeleteStripeSourceResponse) {}
+}

package/src/proto/task.proto

@@ -0,0 +1,39 @@
+syntax = "proto3";
+
+import "error.proto";
+import "common.proto";
+
+/****************************************************************************************
+  Task Models
+****************************************************************************************/
+
+message Task {
+  string _id = 0;
+  string taskType = 1;
+  int32 createdAt = 2;
+  int32 executeAt = 3;
+  int32 startedAt = 4;
+  int32 endedAt = 5;
+  bool success = 6;
+  string userId = 7;
+  string orgId = 8;
+  string eventId = 9;
+  string orderId = 10;
+  repeated string venueIds = 11;
+  repeated string artistIds = 12;
+}
+
+message CreateTaskRequest {
+  string spanContext = 0;
+  repeated Task task = 1;
+}
+
+message CreateTaskResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+service TaskService {
+  // Create
+  rpc createTask(CreateTaskRequest) returns (CreateTaskResponse) {}
+}

package/src/proto/twilio.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+
+import "error.proto";
+
+message RegisterTwilioUserRequest {
+  string spanContext = 0;
+  string email = 1;
+  string phoneNumber = 2;
+}
+
+message RegisterTwilioUserResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  string authyId = 2;
+}
+
+message SendTwilioVerificationRequest {
+  string spanContext = 0;
+  string phoneNumber = 1;
+}
+
+message SendTwilioVerificationResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+message VerifyTwilioTokenRequest {
+  string spanContext = 0;
+  string phoneNumber = 1;
+  string token = 2;
+}
+
+message VerifyTwilioTokenResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  bool phoneVerified = 2;
+}
+
+service TwilioService {
+  rpc registerTwilioUser(RegisterTwilioUserRequest) returns (RegisterTwilioUserResponse) {}
+  rpc sendTwilioVerification(SendTwilioVerificationRequest) returns (SendTwilioVerificationResponse) {}
+  rpc verifyTwilioToken(VerifyTwilioTokenRequest) returns (VerifyTwilioTokenResponse) {}
+}

package/src/proto/user-profile.proto

@@ -0,0 +1,124 @@
+syntax = "proto3";
+
+import "error.proto";
+import "common.proto";
+
+message UserProfile {
+  string _id = 0;
+  string userId = 1;
+  string firstName = 2;
+  string lastName = 3;
+  string email = 4;
+  string phoneNumber = 5;
+  string authyId = 6;
+  string stripeCustomerId = 7;
+  string imageUrl = 8;
+  repeated Metrics metrics = 9;
+  repeated string orgIds = 10;
+  repeated string eventIds = 11;
+  repeated string venueIds = 12;
+  repeated string artistIds = 13;
+  Address address = 14;
+}
+
+/****************************************************************************************
+  Create Profile
+****************************************************************************************/
+message CreateUserProfileRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string firstName = 2;
+  string lastName = 3;
+  string email = 4;
+  string phoneNumber = 5;
+}
+
+message CreateUserProfileResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  UserProfile userProfile = 2;
+}
+
+
+/****************************************************************************************
+  Update Profile
+****************************************************************************************/
+message UpdateUserProfileRequest {
+  string spanContext = 0;
+  UserProfile userProfile = 1;
+  string userId = 2;
+}
+
+message UpdateUserProfileResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  UserProfile userProfile = 2;
+}
+
+/****************************************************************************************
+  Profile Report
+****************************************************************************************/
+
+message GenerateUserProfileReportRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  UserProfileQuery query = 2;
+}
+
+message GenerateUserProfileReportResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  string url = 2;
+}
+
+
+/****************************************************************************************
+  Find Profile
+****************************************************************************************/
+
+message UserProfileQuery {
+  repeated string eventIds = 0;
+  repeated string venueIds = 1; 
+  repeated string artistIds = 2;
+  repeated string userIds = 3;
+  string name = 4;
+  string email = 5;
+  string phoneNumber = 6;
+  bool any = 7;
+}
+
+message QueryUserProfilesRequest {
+  string spanContext = 0;
+  string orgId = 1;
+  UserProfileQuery query = 2;
+  Pagination pagination = 3;
+}
+
+message QueryUserProfilesResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  repeated UserProfile userProfiles = 2;
+}
+
+message FindUserProfileRequest {
+  string spanContext = 0;
+  string userId = 1;
+}
+
+message FindUserProfileResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  UserProfile userProfile = 2;
+}
+
+service UserProfileService {
+  // Create
+  rpc createUserProfile(CreateUserProfileRequest) returns (CreateUserProfileResponse) {}
+  // Update
+  rpc updateUserProfile(UpdateUserProfileRequest) returns (UpdateUserProfileResponse) {}
+  // Report
+  rpc generateUserProfileReport(GenerateUserProfileReportRequest) returns (GenerateUserProfileReportResponse) {}
+  // Find
+  rpc findUserProfile(FindUserProfileRequest) returns (FindUserProfileResponse) {}  
+  rpc queryUserProfiles(QueryUserProfilesRequest) returns (QueryUserProfilesResponse) {}  
+}

package/src/proto/user.proto

@@ -0,0 +1,284 @@
+syntax = "proto3";
+
+import "error.proto";
+
+message User {
+  string _id = 1;
+  string email = 2;
+  string password = 3;
+  string passwordHash = 4;
+  string firstName = 5;
+  string lastName = 6;
+  int32 createdAt = 7;
+  string phoneNumber = 8;
+  int32 phoneNumberVerifiedAt = 9;
+  string emailVerifyCode = 10;
+  int32 emailVerifiedAt = 11;
+  string forgotPasswordCode = 12;
+  int32 lastChangedPasswordAt = 13;
+  string orgContextId = 14;
+  string orgRole = 15;
+  string phoneNumberWaitingForVerify = 16;
+  string emailWaitingForVerify = 17;
+  string  preferredLogin = 18;
+}
+
+// Create User
+
+message CreateUserRequest {
+  string spanContext = 0;
+  User user = 1;
+}
+
+message CreateUserResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+}
+ 
+
+// Verify Email
+
+message SendUserEmailVerificationRequest {
+  string spanContext = 0;
+  string userId = 1;
+}
+
+message SendUserEmailVerificationResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+}
+
+message VerifyUserEmailRequest {
+  string spanContext = 0;
+  string emailVerificationToken = 1;
+}
+
+message VerifyUserEmailResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  bool emailVerified = 2;
+}
+
+//Verify Phone
+message SendUserPhoneVerificationRequest {
+  string spanContext = 1;
+  string userId = 2;
+}
+
+message SendUserPhoneVerificationResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+}
+
+message VerifyUserPhoneNumberRequest {
+  string spanContext = 1;
+  string userId = 2;
+  string phoneVerificationToken = 3;
+}
+
+message VerifyUserPhoneNumberResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  bool phoneVerified = 3;
+}
+
+// Set User Organization Context Id
+
+message SetUserOrgContextIdRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string orgId = 2;
+}
+
+message SetUserOrgContextIdResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+  string token = 4;
+}
+
+// Auth User
+
+message AuthUserRequest {
+  string spanContext = 1;
+  string email = 2;
+  string password = 3;
+}
+
+message AuthUserResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+  string token = 4;
+}
+
+// Phone Authentication
+
+message UserPhoneAuthenticationRequest {
+  string spanContext = 0; 
+  string email = 1;
+  string phoneNumber = 2; 
+}
+
+message UserPhoneAuthenticationResponse {
+  StatusCode status = 1; 
+  repeated Error errors = 2; 
+  User user = 3; 
+  string phoneNumber = 4; 
+}
+
+message VerifyUserPhoneAuthenticationRequest {
+  string spanContext = 0;
+  string email = 1;
+  string phoneNumber = 2;
+  string phoneVerificationToken = 3;
+}
+
+message VerifyUserPhoneAuthenticationResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+  string token = 4;
+}
+
+// Forgot Password
+message ForgotUserPasswordRequest {
+  string spanContext = 1;
+  string email = 2;
+}
+
+message ForgotUserPasswordResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+}
+
+message ResetUserPasswordRequest {
+  string spanContext = 1;
+  string forgotPasswordCode = 2;
+  string password = 3;
+}
+
+message ResetUserPasswordResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+}
+
+// update user password - for when user only has phone login and wants to add password
+message SetUserPasswordRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string password = 2;
+}
+
+message SetUserPasswordResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  User user = 2;
+}
+
+// Find User
+
+message FindUserByIdRequest {
+  string spanContext = 1;
+  string userId = 2;
+}
+
+message FindUserByIdResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+}
+
+message FindUserByEmailRequest {
+  string spanContext = 1;
+  string email = 2;
+}
+
+message FindUserByEmailResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+}
+
+// Update User Phone and Email
+
+message UpdateUserPhoneNumberRequest {
+  string spanContext = 1;
+  string userId = 2;
+  string newPhoneNumber = 3;
+}
+
+message UpdateUserPhoneNumberResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+}
+
+message UpdateUserEmailRequest {
+  string spanContext = 1;
+  string userId = 2;
+  string newEmail = 3;
+}
+
+message UpdateUserEmailResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+}
+
+// Update login method
+message UpdateUserPreferredLoginRequest {
+  string spanContext = 1;
+  string userId = 2;
+  string preferredLogin = 3;
+}
+
+message UpdateUserPreferredLoginResponse {
+  StatusCode status = 1;
+  repeated Error errors = 2;
+  User user = 3;
+}
+
+// Delete User
+message DeleteUnverifiedUserRequest {
+  string spanContext = 0;
+  string userId = 1;
+  string email = 2;
+  string phoneNumber = 3;
+}
+
+message DeleteUnverifiedUserResponse {
+  StatusCode status = 0;
+  repeated Error errors = 1;
+  bool deleted = 2;
+}
+
+service UserService {
+  // Create
+  rpc createUser(CreateUserRequest) returns (CreateUserResponse) {}
+  // Verify
+  rpc sendUserEmailVerification(SendUserEmailVerificationRequest) returns (SendUserEmailVerificationResponse) {}
+  rpc verifyUserEmail(VerifyUserEmailRequest) returns (VerifyUserEmailResponse) {}
+  rpc sendUserPhoneVerification(SendUserPhoneVerificationRequest) returns (SendUserPhoneVerificationResponse) {}
+  rpc verifyUserPhoneNumber(VerifyUserPhoneNumberRequest) returns (VerifyUserPhoneNumberResponse) {}
+  // Auth
+  rpc authUser(AuthUserRequest) returns (AuthUserResponse) {}
+  rpc sendUserPhoneAuthentication(UserPhoneAuthenticationRequest) returns (UserPhoneAuthenticationResponse) {}
+  rpc verifyUserPhoneAuthentication(VerifyUserPhoneAuthenticationRequest) returns (VerifyUserPhoneAuthenticationResponse) {}
+  // Org Context 
+  rpc setUserOrgContextId(SetUserOrgContextIdRequest) returns (SetUserOrgContextIdResponse) {}
+  // Forgot Passord
+  rpc forgotUserPassword(ForgotUserPasswordRequest) returns (ForgotUserPasswordResponse) {}
+  rpc resetUserPassword(ResetUserPasswordRequest) returns (ResetUserPasswordResponse) {}
+  // Find
+  rpc findUserById(FindUserByIdRequest) returns (FindUserByIdResponse) {}
+  rpc findUserByEmail(FindUserByEmailRequest) returns (FindUserByEmailResponse) {}
+  // Update
+  rpc updateUserPhoneNumber(UpdateUserPhoneNumberRequest) returns (UpdateUserPhoneNumberResponse) {}
+  rpc updateUserEmail(UpdateUserEmailRequest) returns (UpdateUserEmailResponse) {}
+  rpc updateUserPreferredLogin(UpdateUserPreferredLoginRequest) returns (UpdateUserPreferredLoginResponse) {}
+  rpc setUserPassword(SetUserPasswordRequest) returns (SetUserPasswordResponse) {}
+  // Delete
+  rpc deleteUnverifiedUser(DeleteUnverifiedUserRequest) returns (DeleteUnverifiedUserResponse) {}
+}