@in-human-resources/backend-proto 0.1.0 → 0.1.3

package/api/v1/candidate.proto

@@ -0,0 +1,203 @@
+syntax = "proto3";
+
+package api.v1;
+
+option go_package = "github.com/InHuman-Resources/Backend/Go/proto/gen/api/v1;apiv1";
+
+import "api/v1/common.proto";
+
+// CandidateService is the client-facing candidate profile service.
+service CandidateService {
+  // Profile management
+  rpc GetCandidateProfile(GetCandidateProfileRequest) returns (CandidateProfileResponse);
+  rpc UpdateCandidateProfile(UpdateCandidateProfileRequest) returns (CandidateProfileResponse);
+  rpc UpdateCandidateSkills(UpdateCandidateSkillsRequest) returns (CandidateProfileResponse);
+  rpc UpdateCandidatePreferences(UpdateCandidatePreferencesRequest) returns (CandidateProfileResponse);
+  
+  // Experience management
+  rpc AddCandidateExperience(AddCandidateExperienceRequest) returns (CandidateProfileResponse);
+  rpc UpdateCandidateExperience(UpdateCandidateExperienceRequest) returns (CandidateProfileResponse);
+  rpc DeleteCandidateExperience(DeleteCandidateExperienceRequest) returns (CandidateProfileResponse);
+  
+  // Application readiness
+  rpc CheckApplicationReady(CheckApplicationReadyRequest) returns (CheckApplicationReadyResponse);
+  
+  // Candidate onboarding (step-by-step)
+  rpc GetCandidateOnboardingStatus(GetCandidateOnboardingStatusRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCandidateBasicProfile(SubmitCandidateBasicProfileRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCandidateResume(SubmitCandidateResumeRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCandidateSkills(SubmitCandidateSkillsRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCandidateExperience(SubmitCandidateExperienceRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCandidatePreferences(SubmitCandidatePreferencesRequest) returns (OnboardingStatusResponse);
+  rpc SkipCandidateOnboardingStep(SkipOnboardingStepRequest) returns (OnboardingStatusResponse);
+  rpc CompleteCandidateOnboarding(CompleteOnboardingRequest) returns (OnboardingStatusResponse);
+}
+
+// ==================== Profile Management ====================
+
+message GetCandidateProfileRequest {
+  // User ID extracted from auth token
+}
+
+message CandidateProfileResponse {
+  string id = 1;
+  string user_id = 2;
+  string professional_headline = 3;
+  string phone = 4;
+  string location_city = 5;
+  string location_country = 6;
+  string linkedin_url = 7;
+  string resume_url = 8;
+  int32 years_of_experience = 9;
+  repeated CandidateSkill skills = 10;
+  repeated CandidateExperience experience = 11;
+  CandidatePreferences preferences = 12;
+  int32 profile_completion_percentage = 13;
+  bool can_apply_to_jobs = 14;
+}
+
+message CandidateSkill {
+  string id = 1;
+  string skill_name = 2;
+  string proficiency_level = 3;  // "beginner", "intermediate", "advanced", "expert"
+}
+
+message CandidateExperience {
+  string id = 1;
+  string job_title = 2;
+  string company_name = 3;
+  string location = 4;
+  string start_date = 5;  // YYYY-MM format
+  string end_date = 6;    // YYYY-MM format or empty if current
+  bool is_current = 7;
+  string description = 8;
+}
+
+message CandidatePreferences {
+  repeated string preferred_job_types = 1;      // "full_time", "part_time", "contract", "freelance"
+  repeated string preferred_industries = 2;
+  int32 expected_salary_min = 3;
+  int32 expected_salary_max = 4;
+  string expected_salary_currency = 5;          // "USD", "EUR", "EGP", etc.
+  string preferred_work_mode = 6;               // "remote", "hybrid", "onsite"
+  string availability = 7;                       // "immediate", "2_weeks", "1_month", "3_months"
+}
+
+message UpdateCandidateProfileRequest {
+  string professional_headline = 1;
+  string phone = 2;
+  string location_city = 3;
+  string location_country = 4;
+  string linkedin_url = 5;
+  int32 years_of_experience = 6;
+  // User ID extracted from auth token
+}
+
+message UpdateCandidateSkillsRequest {
+  repeated CandidateSkillInput skills = 1;
+  // User ID extracted from auth token
+}
+
+message CandidateSkillInput {
+  string skill_name = 1;
+  string proficiency_level = 2;
+}
+
+message UpdateCandidatePreferencesRequest {
+  repeated string preferred_job_types = 1;
+  repeated string preferred_industries = 2;
+  int32 expected_salary_min = 3;
+  int32 expected_salary_max = 4;
+  string expected_salary_currency = 5;
+  string preferred_work_mode = 6;
+  string availability = 7;
+  // User ID extracted from auth token
+}
+
+// ==================== Experience Management ====================
+
+message AddCandidateExperienceRequest {
+  string job_title = 1;
+  string company_name = 2;
+  string location = 3;
+  string start_date = 4;
+  string end_date = 5;
+  bool is_current = 6;
+  string description = 7;
+  // User ID extracted from auth token
+}
+
+message UpdateCandidateExperienceRequest {
+  string experience_id = 1;
+  string job_title = 2;
+  string company_name = 3;
+  string location = 4;
+  string start_date = 5;
+  string end_date = 6;
+  bool is_current = 7;
+  string description = 8;
+  // User ID extracted from auth token
+}
+
+message DeleteCandidateExperienceRequest {
+  string experience_id = 1;
+  // User ID extracted from auth token
+}
+
+// ==================== Application Readiness ====================
+
+message CheckApplicationReadyRequest {
+  // User ID extracted from auth token
+}
+
+message CheckApplicationReadyResponse {
+  bool can_apply = 1;
+  repeated string missing_fields = 2;
+  int32 completion_percentage = 3;
+}
+
+// ==================== Candidate Onboarding ====================
+
+message GetCandidateOnboardingStatusRequest {
+  // User ID extracted from auth token
+}
+
+message SubmitCandidateBasicProfileRequest {
+  string professional_headline = 1;
+  string phone = 2;
+  string location_city = 3;
+  string location_country = 4;
+  // User ID extracted from auth token
+}
+
+message SubmitCandidateResumeRequest {
+  string resume_url = 1;
+  string resume_filename = 2;
+  // User ID extracted from auth token
+}
+
+message SubmitCandidateSkillsRequest {
+  repeated CandidateSkillInput skills = 1;
+  // User ID extracted from auth token
+}
+
+message SubmitCandidateExperienceRequest {
+  string job_title = 1;
+  string company_name = 2;
+  string location = 3;
+  string start_date = 4;
+  string end_date = 5;
+  bool is_current = 6;
+  string description = 7;
+  // User ID extracted from auth token
+}
+
+message SubmitCandidatePreferencesRequest {
+  repeated string preferred_job_types = 1;
+  string preferred_work_mode = 2;
+  string availability = 3;
+  int32 expected_salary_min = 4;
+  int32 expected_salary_max = 5;
+  string expected_salary_currency = 6;
+  // User ID extracted from auth token
+}

package/api/v1/common.proto

@@ -0,0 +1,66 @@
+syntax = "proto3";
+
+package api.v1;
+
+option go_package = "github.com/InHuman-Resources/Backend/Go/proto/gen/api/v1;apiv1";
+
+// RequestContext contains metadata about the client request.
+// This is optional and can be used for idempotency, tracing, etc.
+message RequestContext {
+  string request_id = 1;
+  string idempotency_key = 2;
+  string client_version = 3;
+  string device_type = 4;  // "mobile", "web", "desktop"
+  string device_id = 5;
+  map<string, string> metadata = 10;
+}
+
+// ProfileCompletion tracks how complete a user's profile is.
+message ProfileCompletion {
+  int32 completion_percentage = 1;
+  bool can_apply_to_jobs = 2;
+  repeated string missing_for_application = 3;
+  string next_suggested_action = 4;
+}
+
+// SessionInfo represents an active user session.
+message SessionInfo {
+  string session_id = 1;
+  string ip_address = 2;
+  string user_agent = 3;
+  string device_name = 4;
+  string location = 5;
+  string last_used_at = 6;
+  string created_at = 7;
+  bool is_current = 8;
+}
+
+// Empty is used for RPCs that don't return data (just success/failure).
+message Empty {}
+
+// ==================== Shared Onboarding Types ====================
+
+// OnboardingStatusResponse is used by both company and candidate onboarding flows.
+message OnboardingStatusResponse {
+  string entity_id = 1;
+  string current_step = 2;
+  bool onboarding_complete = 3;
+  repeated OnboardingStepDetail steps = 4;
+  int32 profile_completion_percentage = 5;
+}
+
+message OnboardingStepDetail {
+  string step = 1;
+  bool completed = 2;
+  bool skippable = 3;
+  bool skipped = 4;
+}
+
+message SkipOnboardingStepRequest {
+  string step = 1;
+  // User ID extracted from auth token
+}
+
+message CompleteOnboardingRequest {
+  // User ID extracted from auth token
+}

package/api/v1/company.proto

@@ -0,0 +1,203 @@
+syntax = "proto3";
+
+package api.v1;
+
+option go_package = "github.com/InHuman-Resources/Backend/Go/proto/gen/api/v1;apiv1";
+
+import "api/v1/common.proto";
+
+// CompanyService is the client-facing company management service.
+service CompanyService {
+  // Company CRUD
+  rpc GetCompany(GetCompanyRequest) returns (GetCompanyResponse);
+  rpc GetMyCompany(GetMyCompanyRequest) returns (GetCompanyResponse);
+  rpc UpdateCompanyProfile(UpdateCompanyProfileRequest) returns (CompanyProfileResponse);
+  
+  // Company members
+  rpc GetMyCompanyMembership(GetMyCompanyMembershipRequest) returns (CompanyMemberInfo);
+  rpc ListCompanyMembers(ListCompanyMembersRequest) returns (ListCompanyMembersResponse);
+  rpc InviteCompanyMember(InviteCompanyMemberRequest) returns (Empty);
+  rpc AcceptCompanyInvitation(AcceptCompanyInvitationRequest) returns (AcceptCompanyInvitationResponse);
+  rpc RemoveCompanyMember(RemoveCompanyMemberRequest) returns (Empty);
+  rpc UpdateCompanyMemberRole(UpdateCompanyMemberRoleRequest) returns (Empty);
+  
+  // Company onboarding (step-by-step)
+  rpc GetCompanyOnboardingStatus(GetCompanyOnboardingStatusRequest) returns (OnboardingStatusResponse);
+  rpc SubmitAccountSetup(SubmitAccountSetupRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCompanyInfo(SubmitCompanyInfoRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCompanyDetails(SubmitCompanyDetailsRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCompanyBranding(SubmitCompanyBrandingRequest) returns (OnboardingStatusResponse);
+  rpc SubmitCompanyInviteTeam(SubmitCompanyInviteTeamRequest) returns (OnboardingStatusResponse);
+  rpc SkipCompanyOnboardingStep(SkipOnboardingStepRequest) returns (OnboardingStatusResponse);
+  rpc CompleteCompanyOnboarding(CompleteOnboardingRequest) returns (OnboardingStatusResponse);
+}
+
+// ==================== Company CRUD ====================
+
+message GetCompanyRequest {
+  string company_id = 1;
+}
+
+message GetMyCompanyRequest {
+  // User ID extracted from auth token
+}
+
+message GetCompanyResponse {
+  string company_id = 1;
+  string name = 2;
+  string slug = 3;
+  string website = 4;
+  string status = 5;
+  string created_at = 6;
+  string onboarding_status = 7;
+  string logo_url = 8;
+  string industry = 9;
+  string company_size = 10;
+  string description = 11;
+  string city = 12;
+  string country = 13;
+  int32 founded_year = 14;
+  string linkedin_url = 15;
+  string twitter_url = 16;
+}
+
+message CompanyProfileResponse {
+  string id = 1;
+  string name = 2;
+  string slug = 3;
+  string industry = 4;
+  string company_size = 5;
+  string description = 6;
+  string city = 7;
+  string country = 8;
+  string website = 9;
+  string logo_url = 10;
+  string linkedin_url = 11;
+  string twitter_url = 12;
+  int32 founded_year = 13;
+  int32 profile_completion_percentage = 14;
+  string status = 15;
+}
+
+message UpdateCompanyProfileRequest {
+  string name = 1;
+  string industry = 2;
+  string company_size = 3;
+  string description = 4;
+  string city = 5;
+  string country = 6;
+  string website = 7;
+  string logo_url = 8;
+  string linkedin_url = 9;
+  string twitter_url = 10;
+  int32 founded_year = 11;
+  // User ID extracted from auth token
+}
+
+// ==================== Company Members ====================
+
+message GetMyCompanyMembershipRequest {
+  // User ID extracted from auth token
+}
+
+message CompanyMemberInfo {
+  string member_id = 1;
+  string user_id = 2;
+  string user_name = 3;
+  string user_email = 4;
+  string company_id = 5;
+  string company_name = 6;
+  string hierarchy_level = 7;
+  string department = 8;
+  string joined_at = 9;
+}
+
+message ListCompanyMembersRequest {
+  string company_id = 1;
+}
+
+message ListCompanyMembersResponse {
+  repeated CompanyMemberInfo members = 1;
+}
+
+message InviteCompanyMemberRequest {
+  string company_id = 1;
+  string email = 2;
+  string hierarchy_level = 3;
+  string department = 4;
+  // Inviter user ID extracted from auth token
+}
+
+message AcceptCompanyInvitationRequest {
+  string token = 1;
+  // User ID extracted from auth token
+}
+
+message AcceptCompanyInvitationResponse {
+  string access_token = 1;
+  string refresh_token = 2;
+  string user_type = 3;
+  bool email_verified = 4;
+  string onboarding_step = 5;
+  bool onboarding_complete = 6;
+  string company_id = 7;
+  string hierarchy_level = 8;
+  string department = 9;
+}
+
+message RemoveCompanyMemberRequest {
+  string company_id = 1;
+  string target_user_id = 2;
+  // Remover user ID extracted from auth token
+}
+
+message UpdateCompanyMemberRoleRequest {
+  string company_id = 1;
+  string target_user_id = 2;
+  string hierarchy_level = 3;
+  string department = 4;
+  // Updater user ID extracted from auth token
+}
+
+// ==================== Company Onboarding ====================
+
+message GetCompanyOnboardingStatusRequest {
+  // User ID extracted from auth token
+}
+
+message SubmitAccountSetupRequest {
+  string company_name = 1;
+  string company_slug = 2;
+  string department = 3;  // "hr" or "tech_lead"
+  string role = 4;        // "hr", "founder", "tech_lead"
+  // User ID extracted from auth token
+}
+
+message SubmitCompanyInfoRequest {
+  string industry = 1;
+  string company_size = 2;
+  string description = 3;
+  // User ID extracted from auth token
+}
+
+message SubmitCompanyDetailsRequest {
+  string city = 1;
+  string country = 2;
+  string website = 3;
+  int32 founded_year = 4;
+  // User ID extracted from auth token
+}
+
+message SubmitCompanyBrandingRequest {
+  string logo_url = 1;
+  string linkedin_url = 2;
+  string twitter_url = 3;
+  // User ID extracted from auth token
+}
+
+message SubmitCompanyInviteTeamRequest {
+  repeated string emails = 1;
+  string hierarchy_level = 2;
+  string department = 3;
+  // User ID extracted from auth token
+}