@osise/api-client 0.0.1 → 0.0.2

package/dist/types/types/b2b.d.ts

@@ -0,0 +1,687 @@
+/**
+ * B2B DTOs
+ * Types for B2B company management, team, properties, and reports
+ */
+import { ContractType, CompanyStatus, CompanyUserRole, ContractStatus } from './enums';
+import { PaginationParams } from './common';
+/** Company information visible to B2B consumers */
+export interface CompanyInfoDto {
+    companyId: string;
+    name: string;
+    code: string;
+    logoUrl?: string;
+    myRole: string;
+    permissions: CompanyPermissionsDto;
+    contract?: ContractSummaryDto;
+    teamMemberCount: number;
+    propertyCount: number;
+}
+/** User's permissions within the company */
+export interface CompanyPermissionsDto {
+    canRequestServices: boolean;
+    canApproveRequests: boolean;
+    canViewReports: boolean;
+    canManageTeam: boolean;
+    spendingLimit?: number;
+}
+/** Summary of active contract for B2B consumers */
+export interface ContractSummaryDto {
+    type: string;
+    includedHours: number;
+    hoursUsedThisPeriod: number;
+    hoursRemaining: number;
+    currentPeriodEnd: string;
+    hasPriorityScheduling: boolean;
+}
+/** Request to link to a company using company code */
+export interface LinkCompanyDto {
+    companyCode: string;
+}
+/** Team list request parameters */
+export interface TeamListRequestDto extends PaginationParams {
+    search?: string;
+    role?: string;
+    isActive?: boolean;
+}
+/** Team list response */
+export interface TeamListResponseDto {
+    members: TeamMemberInfoDto[];
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+/** Team member information */
+export interface TeamMemberInfoDto {
+    id: string;
+    consumerId: string;
+    fullName: string;
+    phoneNumber: string;
+    email?: string;
+    profileImageUrl?: string;
+    role: string;
+    jobTitle?: string;
+    department?: string;
+    canRequestServices: boolean;
+    canApproveRequests: boolean;
+    canViewReports: boolean;
+    canManageTeam: boolean;
+    spendingLimit?: number;
+    joinedAt: string;
+    isActive: boolean;
+}
+/** Request to invite a team member */
+export interface InviteTeamMemberDto {
+    phoneNumber: string;
+    role?: string;
+    jobTitle?: string;
+    department?: string;
+    canRequestServices?: boolean;
+    canApproveRequests?: boolean;
+    canViewReports?: boolean;
+    spendingLimit?: number;
+}
+/** Request to update a team member's role */
+export interface UpdateTeamMemberRoleDto {
+    role: string;
+    jobTitle?: string;
+    department?: string;
+    canRequestServices?: boolean;
+    canApproveRequests?: boolean;
+    canViewReports?: boolean;
+    spendingLimit?: number;
+}
+/** Monthly report response */
+export interface B2BReportDto {
+    companyId: string;
+    companyName: string;
+    reportMonth: string;
+    periodStart: string;
+    periodEnd: string;
+    contract: ReportContractSummaryDto;
+    jobs: ReportJobSummaryDto;
+    financial: ReportFinancialSummaryDto;
+    sla: ReportSlaSummaryDto;
+    topCategories: ReportCategoryDto[];
+    generatedAt: string;
+}
+/** Contract summary for report */
+export interface ReportContractSummaryDto {
+    type: string;
+    includedHours: number;
+    hoursUsed: number;
+    usagePercentage: number;
+}
+/** Job summary for report */
+export interface ReportJobSummaryDto {
+    total: number;
+    completed: number;
+    cancelled: number;
+    averageRating: number;
+}
+/** Financial summary for report */
+export interface ReportFinancialSummaryDto {
+    totalCost: number;
+    monthlyFee: number;
+    overtimeCharges: number;
+    materialsCost: number;
+}
+/** SLA summary for report */
+export interface ReportSlaSummaryDto {
+    emergencyCompliance: number;
+    routineCompliance: number;
+    overallCompliance: number;
+}
+/** Category breakdown for report */
+export interface ReportCategoryDto {
+    name: string;
+    jobCount: number;
+    percentage: number;
+}
+/** Property list request parameters */
+export interface ConsumerPropertyListRequestDto extends PaginationParams {
+    search?: string;
+    propertyType?: string;
+    isActive?: boolean;
+}
+/** Property list response */
+export interface ConsumerPropertyListResponseDto {
+    properties: PropertyInfoDto[];
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+/** Property information for list */
+export interface PropertyInfoDto {
+    id: string;
+    name: string;
+    code?: string;
+    propertyType?: string;
+    address: string;
+    city: string;
+    state: string;
+    managerName?: string;
+    managerPhone?: string;
+    isActive: boolean;
+}
+/** Detailed property response */
+export interface ConsumerPropertyDetailDto {
+    id: string;
+    name: string;
+    code?: string;
+    propertyType?: string;
+    description?: string;
+    street: string;
+    area?: string;
+    city: string;
+    state: string;
+    latitude?: number;
+    longitude?: number;
+    floors?: number;
+    areaSqMeters?: number;
+    units?: number;
+    yearBuilt?: number;
+    managerName?: string;
+    managerPhone?: string;
+    managerEmail?: string;
+    accessInstructions?: string;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt?: string;
+}
+/** Request to create a B2B property */
+export interface CreateB2BPropertyDto {
+    name: string;
+    street: string;
+    city: string;
+    state: string;
+    code?: string;
+    propertyType?: string;
+    description?: string;
+    area?: string;
+    managerName?: string;
+    managerPhone?: string;
+    managerEmail?: string;
+    accessInstructions?: string;
+}
+/** Request to update a B2B property */
+export interface UpdateB2BPropertyDto {
+    name?: string;
+    code?: string;
+    propertyType?: string;
+    description?: string;
+    street?: string;
+    area?: string;
+    city?: string;
+    state?: string;
+    managerName?: string;
+    managerPhone?: string;
+    managerEmail?: string;
+    accessInstructions?: string;
+    isActive?: boolean;
+}
+/** Admin company list item */
+export interface AdminCompanyListItemDto {
+    id: string;
+    name: string;
+    code: string;
+    industry?: string;
+    status: CompanyStatus;
+    activeContractType?: ContractType;
+    accountManagerName?: string;
+    userCount: number;
+    propertyCount: number;
+    createdAt: string;
+}
+/** Admin company detail */
+export interface AdminCompanyDetailDto {
+    id: string;
+    name: string;
+    code: string;
+    industry?: string;
+    website?: string;
+    logoUrl?: string;
+    status: CompanyStatus;
+    billingEmail: string;
+    billingPhone?: string;
+    taxId?: string;
+    notes?: string;
+    accountManagerId?: string;
+    accountManagerName?: string;
+    addresses: AdminCompanyAddressDto[];
+    activeContract?: AdminContractDto;
+    userCount: number;
+    propertyCount: number;
+    totalJobsCompleted: number;
+    totalSpend: number;
+    createdAt: string;
+    updatedAt?: string;
+}
+/** Company address for admin */
+export interface AdminCompanyAddressDto {
+    id: string;
+    type: string;
+    street: string;
+    area?: string;
+    city: string;
+    state: string;
+    isPrimary: boolean;
+}
+/** Request to create a company */
+export interface CreateCompanyDto {
+    name: string;
+    industry?: string;
+    website?: string;
+    logoUrl?: string;
+    billingEmail: string;
+    billingPhone?: string;
+    taxId?: string;
+    notes?: string;
+    accountManagerId?: string;
+    addresses?: CreateCompanyAddressDto[];
+}
+/** Request to create a company address */
+export interface CreateCompanyAddressDto {
+    type: string;
+    street: string;
+    area?: string;
+    city: string;
+    state: string;
+    isPrimary?: boolean;
+}
+/** Request to update a company */
+export interface UpdateCompanyDto {
+    name?: string;
+    industry?: string;
+    website?: string;
+    logoUrl?: string;
+    status?: CompanyStatus;
+    billingEmail?: string;
+    billingPhone?: string;
+    taxId?: string;
+    notes?: string;
+    accountManagerId?: string;
+}
+/** Company filter parameters */
+export interface CompanyFilterDto extends PaginationParams {
+    search?: string;
+    industry?: string;
+    status?: CompanyStatus;
+    contractType?: ContractType;
+    accountManagerId?: string;
+}
+/** Result of regenerating company code */
+export interface RegenerateCodeResultDto {
+    companyId: string;
+    oldCode: string;
+    newCode: string;
+}
+/** Request to assign account manager */
+export interface AssignAccountManagerDto {
+    accountManagerId: string;
+}
+/** Company user for admin */
+export interface AdminCompanyUserDto {
+    id: string;
+    consumerId: string;
+    fullName: string;
+    phoneNumber: string;
+    email?: string;
+    profileImageUrl?: string;
+    role: CompanyUserRole;
+    jobTitle?: string;
+    department?: string;
+    canRequestServices: boolean;
+    canApproveRequests: boolean;
+    canViewReports: boolean;
+    canManageTeam: boolean;
+    spendingLimit?: number;
+    joinedAt: string;
+    isActive: boolean;
+}
+/** Request to add a company user */
+export interface AddCompanyUserDto {
+    consumerId: string;
+    role?: CompanyUserRole;
+    jobTitle?: string;
+    department?: string;
+    canRequestServices?: boolean;
+    canApproveRequests?: boolean;
+    canViewReports?: boolean;
+    canManageTeam?: boolean;
+    spendingLimit?: number;
+}
+/** Request to update a company user */
+export interface UpdateCompanyUserDto {
+    role?: CompanyUserRole;
+    jobTitle?: string;
+    department?: string;
+    canRequestServices?: boolean;
+    canApproveRequests?: boolean;
+    canViewReports?: boolean;
+    canManageTeam?: boolean;
+    spendingLimit?: number;
+    isActive?: boolean;
+}
+/** Contract for admin */
+export interface AdminContractDto {
+    id: string;
+    companyId: string;
+    type: ContractType;
+    status: ContractStatus;
+    startDate: string;
+    endDate: string;
+    monthlyFee: number;
+    includedHours: number;
+    overtimeHourlyRate?: number;
+    emergencyResponseHours: number;
+    routineResponseHours: number;
+    paymentTerms?: string;
+    autoRenew: boolean;
+    notes?: string;
+    signedAt?: string;
+    terminatedAt?: string;
+    terminationReason?: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+/** Contract list item */
+export interface AdminContractListItemDto {
+    id: string;
+    companyName: string;
+    type: ContractType;
+    status: ContractStatus;
+    startDate: string;
+    endDate: string;
+    monthlyFee: number;
+    includedHours: number;
+}
+/** Request to create a contract */
+export interface CreateContractDto {
+    type: ContractType;
+    startDate: string;
+    endDate: string;
+    monthlyFee: number;
+    includedHours: number;
+    overtimeHourlyRate?: number;
+    emergencyResponseHours?: number;
+    routineResponseHours?: number;
+    paymentTerms?: string;
+    autoRenew?: boolean;
+    notes?: string;
+}
+/** Request to update a contract */
+export interface UpdateContractDto {
+    type?: ContractType;
+    status?: ContractStatus;
+    startDate?: string;
+    endDate?: string;
+    monthlyFee?: number;
+    includedHours?: number;
+    overtimeHourlyRate?: number;
+    emergencyResponseHours?: number;
+    routineResponseHours?: number;
+    paymentTerms?: string;
+    autoRenew?: boolean;
+    notes?: string;
+}
+/** Contract filter parameters */
+export interface ContractFilterDto extends PaginationParams {
+    companyId?: string;
+    type?: ContractType;
+    status?: ContractStatus;
+    startDateFrom?: string;
+    startDateTo?: string;
+}
+/** Property for admin */
+export interface AdminPropertyDto {
+    id: string;
+    companyId: string;
+    companyName: string;
+    name: string;
+    code?: string;
+    propertyType?: string;
+    description?: string;
+    street: string;
+    area?: string;
+    city: string;
+    state: string;
+    latitude?: number;
+    longitude?: number;
+    floors?: number;
+    areaSqMeters?: number;
+    units?: number;
+    yearBuilt?: number;
+    managerName?: string;
+    managerPhone?: string;
+    managerEmail?: string;
+    accessInstructions?: string;
+    isActive: boolean;
+    jobCount: number;
+    createdAt: string;
+    updatedAt?: string;
+}
+/** Property list item for admin */
+export interface AdminPropertyListItemDto {
+    id: string;
+    companyName: string;
+    name: string;
+    code?: string;
+    propertyType?: string;
+    city: string;
+    state: string;
+    isActive: boolean;
+    jobCount: number;
+}
+/** Request to create a property (admin) */
+export interface AdminCreatePropertyDto {
+    name: string;
+    street: string;
+    city: string;
+    state: string;
+    code?: string;
+    propertyType?: string;
+    description?: string;
+    area?: string;
+    latitude?: number;
+    longitude?: number;
+    floors?: number;
+    areaSqMeters?: number;
+    units?: number;
+    yearBuilt?: number;
+    managerName?: string;
+    managerPhone?: string;
+    managerEmail?: string;
+    accessInstructions?: string;
+}
+/** Request to update a property (admin) */
+export interface AdminUpdatePropertyDto {
+    name?: string;
+    code?: string;
+    propertyType?: string;
+    description?: string;
+    street?: string;
+    area?: string;
+    city?: string;
+    state?: string;
+    latitude?: number;
+    longitude?: number;
+    floors?: number;
+    areaSqMeters?: number;
+    units?: number;
+    yearBuilt?: number;
+    managerName?: string;
+    managerPhone?: string;
+    managerEmail?: string;
+    accessInstructions?: string;
+    isActive?: boolean;
+}
+/** Property filter parameters */
+export interface PropertyFilterDto extends PaginationParams {
+    search?: string;
+    companyId?: string;
+    propertyType?: string;
+    city?: string;
+    state?: string;
+    isActive?: boolean;
+}
+/** Department code for admin */
+export interface AdminDepartmentCodeDto {
+    id: string;
+    companyId: string;
+    code: string;
+    name: string;
+    description?: string;
+    budgetLimit?: number;
+    currentSpend: number;
+    isActive: boolean;
+    createdAt: string;
+}
+/** Request to create a department code */
+export interface CreateDepartmentCodeDto {
+    code: string;
+    name: string;
+    description?: string;
+    budgetLimit?: number;
+}
+/** Request to update a department code */
+export interface UpdateDepartmentCodeDto {
+    code?: string;
+    name?: string;
+    description?: string;
+    budgetLimit?: number;
+    isActive?: boolean;
+}
+/** Meeting note for admin */
+export interface AdminMeetingNoteDto {
+    id: string;
+    companyId: string;
+    companyName: string;
+    meetingDate: string;
+    meetingType: string;
+    category?: string;
+    attendees: string[];
+    summary: string;
+    actionItems: string[];
+    nextSteps?: string;
+    sentiment?: string;
+    createdById: string;
+    createdByName: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+/** Meeting note list item */
+export interface AdminMeetingNoteListItemDto {
+    id: string;
+    companyName: string;
+    meetingDate: string;
+    meetingType: string;
+    category?: string;
+    summary: string;
+    createdByName: string;
+}
+/** Request to create a meeting note */
+export interface CreateMeetingNoteDto {
+    meetingDate: string;
+    meetingType: string;
+    category?: string;
+    attendees: string[];
+    summary: string;
+    actionItems?: string[];
+    nextSteps?: string;
+    sentiment?: string;
+}
+/** Request to update a meeting note */
+export interface UpdateMeetingNoteDto {
+    meetingDate?: string;
+    meetingType?: string;
+    category?: string;
+    attendees?: string[];
+    summary?: string;
+    actionItems?: string[];
+    nextSteps?: string;
+    sentiment?: string;
+}
+/** Meeting note filter parameters */
+export interface MeetingNoteFilterDto extends PaginationParams {
+    companyId?: string;
+    meetingType?: string;
+    category?: string;
+    dateFrom?: string;
+    dateTo?: string;
+    createdById?: string;
+}
+/** Usage report for admin */
+export interface AdminUsageReportDto {
+    companyId: string;
+    companyName: string;
+    periodStart: string;
+    periodEnd: string;
+    contract: UsageReportContractDto;
+    jobs: UsageReportJobsDto;
+    financial: UsageReportFinancialDto;
+    sla: UsageReportSlaDto;
+    categoryBreakdown: UsageReportCategoryDto[];
+    propertyBreakdown: UsageReportPropertyDto[];
+    monthlyTrend: UsageReportMonthDto[];
+    generatedAt: string;
+}
+/** Contract info for usage report */
+export interface UsageReportContractDto {
+    type: string;
+    includedHours: number;
+    hoursUsed: number;
+    hoursRemaining: number;
+    usagePercentage: number;
+}
+/** Job stats for usage report */
+export interface UsageReportJobsDto {
+    total: number;
+    completed: number;
+    cancelled: number;
+    inProgress: number;
+    averageCompletionTime: number;
+    averageRating: number;
+}
+/** Financial stats for usage report */
+export interface UsageReportFinancialDto {
+    monthlyFee: number;
+    overtimeCharges: number;
+    materialsCost: number;
+    totalCost: number;
+    costSavings: number;
+}
+/** SLA stats for usage report */
+export interface UsageReportSlaDto {
+    emergencyResponseTarget: number;
+    emergencyResponseActual: number;
+    emergencyCompliance: number;
+    routineResponseTarget: number;
+    routineResponseActual: number;
+    routineCompliance: number;
+    overallCompliance: number;
+}
+/** Category breakdown for usage report */
+export interface UsageReportCategoryDto {
+    categoryName: string;
+    jobCount: number;
+    totalCost: number;
+    hoursUsed: number;
+    percentage: number;
+}
+/** Property breakdown for usage report */
+export interface UsageReportPropertyDto {
+    propertyId: string;
+    propertyName: string;
+    jobCount: number;
+    totalCost: number;
+}
+/** Monthly data for usage report */
+export interface UsageReportMonthDto {
+    month: string;
+    jobCount: number;
+    totalCost: number;
+    hoursUsed: number;
+}
+//# sourceMappingURL=b2b.d.ts.map