396 lines
17 KiB
Python
396 lines
17 KiB
Python
"""CRM 商机管理 Pydantic Schemas"""
|
||
|
||
from typing import List, Optional
|
||
|
||
from pydantic import BaseModel, ConfigDict, Field
|
||
|
||
|
||
class OpportunityColumnFilterMixin(BaseModel):
|
||
"""列头漏斗参数。"""
|
||
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_no: Optional[str] = Field(default=None, alias="opportunityNo")
|
||
opportunity_no_in: Optional[str] = Field(
|
||
default=None, alias="opportunityNoIn", description="商机编号多选(逗号)"
|
||
)
|
||
opportunity_name: Optional[str] = Field(default=None, alias="opportunityName")
|
||
opportunity_name_in: Optional[str] = Field(
|
||
default=None, alias="opportunityNameIn", description="商机名称多选(逗号)"
|
||
)
|
||
customer_name: Optional[str] = Field(default=None, alias="customerName")
|
||
customer_name_in: Optional[str] = Field(
|
||
default=None, alias="customerNameIn", description="客户名称多选(逗号)"
|
||
)
|
||
customer_id: Optional[str] = Field(default=None, alias="customerId")
|
||
contact_name: Optional[str] = Field(default=None, alias="contactName")
|
||
description: Optional[str] = Field(default=None)
|
||
competitors: Optional[str] = Field(default=None)
|
||
key_factors: Optional[str] = Field(default=None, alias="keyFactors")
|
||
lost_reason: Optional[str] = Field(default=None, alias="lostReason")
|
||
owner_user_name: Optional[str] = Field(default=None, alias="ownerUserName")
|
||
remark: Optional[str] = Field(default=None)
|
||
|
||
stage: Optional[str] = Field(default=None)
|
||
stage_in: Optional[str] = Field(default=None, alias="stageIn")
|
||
status: Optional[str] = Field(default=None)
|
||
status_in: Optional[str] = Field(default=None, alias="statusIn")
|
||
source: Optional[str] = Field(default=None)
|
||
source_in: Optional[str] = Field(default=None, alias="sourceIn")
|
||
type: Optional[str] = Field(default=None)
|
||
type_in: Optional[str] = Field(default=None, alias="typeIn")
|
||
|
||
owner_user_id: Optional[str] = Field(default=None, alias="ownerUserId")
|
||
|
||
begin_time: Optional[str] = Field(default=None, alias="beginTime")
|
||
end_time: Optional[str] = Field(default=None, alias="endTime")
|
||
create_time_from: Optional[str] = Field(default=None, alias="createTimeFrom")
|
||
create_time_to: Optional[str] = Field(default=None, alias="createTimeTo")
|
||
expect_deal_date_from: Optional[str] = Field(default=None, alias="expectDealDateFrom")
|
||
expect_deal_date_to: Optional[str] = Field(default=None, alias="expectDealDateTo")
|
||
actual_deal_date_from: Optional[str] = Field(default=None, alias="actualDealDateFrom")
|
||
actual_deal_date_to: Optional[str] = Field(default=None, alias="actualDealDateTo")
|
||
last_time_from: Optional[str] = Field(default=None, alias="lastTimeFrom")
|
||
last_time_to: Optional[str] = Field(default=None, alias="lastTimeTo")
|
||
next_time_from: Optional[str] = Field(default=None, alias="nextTimeFrom")
|
||
next_time_to: Optional[str] = Field(default=None, alias="nextTimeTo")
|
||
update_time_from: Optional[str] = Field(default=None, alias="updateTimeFrom")
|
||
update_time_to: Optional[str] = Field(default=None, alias="updateTimeTo")
|
||
|
||
amount_op: Optional[str] = Field(default=None, alias="amountOp")
|
||
amount: Optional[str] = Field(default=None)
|
||
amount_min: Optional[str] = Field(default=None, alias="amountMin")
|
||
amount_max: Optional[str] = Field(default=None, alias="amountMax")
|
||
min_amount: Optional[float] = Field(default=None, alias="minAmount")
|
||
max_amount: Optional[float] = Field(default=None, alias="maxAmount")
|
||
stage_percent_op: Optional[str] = Field(default=None, alias="stagePercentOp")
|
||
stage_percent: Optional[str] = Field(default=None, alias="stagePercent")
|
||
stage_percent_min: Optional[str] = Field(default=None, alias="stagePercentMin")
|
||
stage_percent_max: Optional[str] = Field(default=None, alias="stagePercentMax")
|
||
win_rate_op: Optional[str] = Field(default=None, alias="winRateOp")
|
||
win_rate: Optional[str] = Field(default=None, alias="winRate")
|
||
win_rate_min: Optional[str] = Field(default=None, alias="winRateMin")
|
||
win_rate_max: Optional[str] = Field(default=None, alias="winRateMax")
|
||
product_count_op: Optional[str] = Field(default=None, alias="productCountOp")
|
||
product_count: Optional[str] = Field(default=None, alias="productCount")
|
||
product_count_min: Optional[str] = Field(default=None, alias="productCountMin")
|
||
product_count_max: Optional[str] = Field(default=None, alias="productCountMax")
|
||
follow_count_op: Optional[str] = Field(default=None, alias="followCountOp")
|
||
follow_count: Optional[str] = Field(default=None, alias="followCount")
|
||
follow_count_min: Optional[str] = Field(default=None, alias="followCountMin")
|
||
follow_count_max: Optional[str] = Field(default=None, alias="followCountMax")
|
||
|
||
def column_filter_kwargs(self) -> dict:
|
||
amount_min = self.amount_min
|
||
amount_max = self.amount_max
|
||
if amount_min is None and self.min_amount is not None:
|
||
amount_min = str(self.min_amount)
|
||
if amount_max is None and self.max_amount is not None:
|
||
amount_max = str(self.max_amount)
|
||
return {
|
||
"opportunity_no": self.opportunity_no,
|
||
"opportunity_no_in": self.opportunity_no_in,
|
||
"opportunity_name": self.opportunity_name,
|
||
"opportunity_name_in": self.opportunity_name_in,
|
||
"customer_name": self.customer_name,
|
||
"customer_name_in": self.customer_name_in,
|
||
"customer_id": self.customer_id,
|
||
"contact_name": self.contact_name,
|
||
"description": self.description,
|
||
"competitors": self.competitors,
|
||
"key_factors": self.key_factors,
|
||
"lost_reason": self.lost_reason,
|
||
"owner_user_name": self.owner_user_name,
|
||
"remark": self.remark,
|
||
"stage": self.stage,
|
||
"stage_in": self.stage_in,
|
||
"status": self.status,
|
||
"status_in": self.status_in,
|
||
"source": self.source,
|
||
"source_in": self.source_in,
|
||
"type": self.type,
|
||
"type_in": self.type_in,
|
||
"owner_user_id": self.owner_user_id,
|
||
"begin_time": self.begin_time,
|
||
"end_time": self.end_time,
|
||
"create_time_from": self.create_time_from,
|
||
"create_time_to": self.create_time_to,
|
||
"expect_deal_date_from": self.expect_deal_date_from,
|
||
"expect_deal_date_to": self.expect_deal_date_to,
|
||
"actual_deal_date_from": self.actual_deal_date_from,
|
||
"actual_deal_date_to": self.actual_deal_date_to,
|
||
"last_time_from": self.last_time_from,
|
||
"last_time_to": self.last_time_to,
|
||
"next_time_from": self.next_time_from,
|
||
"next_time_to": self.next_time_to,
|
||
"update_time_from": self.update_time_from,
|
||
"update_time_to": self.update_time_to,
|
||
"amount_op": self.amount_op,
|
||
"amount": self.amount,
|
||
"amount_min": amount_min,
|
||
"amount_max": amount_max,
|
||
"stage_percent_op": self.stage_percent_op,
|
||
"stage_percent": self.stage_percent,
|
||
"stage_percent_min": self.stage_percent_min,
|
||
"stage_percent_max": self.stage_percent_max,
|
||
"win_rate_op": self.win_rate_op,
|
||
"win_rate": self.win_rate,
|
||
"win_rate_min": self.win_rate_min,
|
||
"win_rate_max": self.win_rate_max,
|
||
"product_count_op": self.product_count_op,
|
||
"product_count": self.product_count,
|
||
"product_count_min": self.product_count_min,
|
||
"product_count_max": self.product_count_max,
|
||
"follow_count_op": self.follow_count_op,
|
||
"follow_count": self.follow_count,
|
||
"follow_count_min": self.follow_count_min,
|
||
"follow_count_max": self.follow_count_max,
|
||
}
|
||
|
||
|
||
class OpportunityListBody(OpportunityColumnFilterMixin):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
page: int = Field(default=1, ge=1, description="页码")
|
||
pageSize: int = Field(default=10, ge=1, le=500, description="每页条数")
|
||
keyword: Optional[str] = Field(default=None, description="关键词(商机名/客户名 OR)")
|
||
view_type: Optional[str] = Field(default=None, alias="viewType", description="mine/all")
|
||
create_time_range: Optional[List[str]] = Field(default=None, alias="createTimeRange")
|
||
|
||
ids: Optional[List[str]] = Field(default=None, description="导出指定ID列表")
|
||
columns: Optional[List[str]] = Field(default=None, description="导出列(前端 visibleColumns)")
|
||
|
||
def to_list_kwargs(self, *, view_type_override: Optional[str] = None) -> dict:
|
||
kwargs = {
|
||
"keyword": (self.keyword or "").strip() or None,
|
||
"view_type": view_type_override or self.view_type,
|
||
**self.column_filter_kwargs(),
|
||
}
|
||
if self.create_time_range and len(self.create_time_range) == 2:
|
||
kwargs["begin_time"] = self.create_time_range[0]
|
||
kwargs["end_time"] = self.create_time_range[1]
|
||
kwargs["create_time_from"] = None
|
||
kwargs["create_time_to"] = None
|
||
return kwargs
|
||
|
||
|
||
class OpportunityColumnFacetBody(OpportunityColumnFilterMixin):
|
||
"""商机列表列头可选值(去重;继承列筛 Mixin 支持 Excel 级联)"""
|
||
|
||
model_config = ConfigDict(populate_by_name=True, extra="allow")
|
||
|
||
field: str = Field(..., description="opportunityNo | opportunityName | customerName")
|
||
keyword: Optional[str] = Field(default=None, description="列表搜索关键词")
|
||
limit: Optional[int] = Field(default=500, ge=1, le=500, description="返回条数上限")
|
||
view_type: Optional[str] = Field(default=None, alias="viewType", description="mine/all")
|
||
|
||
|
||
class OpportunityDetailBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
id: str = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityCreateBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_no: Optional[str] = Field(default=None, alias="opportunityNo")
|
||
opportunity_name: str = Field(..., alias="opportunityName", min_length=1, max_length=200)
|
||
customer_id: str = Field(..., alias="customerId")
|
||
contact_id: Optional[str] = Field(default=None, alias="contactId")
|
||
stage: Optional[str] = Field(default="initial")
|
||
stage_percent: Optional[int] = Field(default=None, alias="stagePercent")
|
||
win_rate: Optional[float] = Field(default=None, alias="winRate")
|
||
amount: Optional[float] = Field(default=0)
|
||
expect_deal_date: Optional[str] = Field(default=None, alias="expectDealDate")
|
||
source: Optional[str] = Field(default=None)
|
||
type: Optional[str] = Field(default=None)
|
||
description: Optional[str] = Field(default=None)
|
||
owner_user_id: Optional[str] = Field(default=None, alias="ownerUserId")
|
||
competitors: Optional[str] = Field(default=None)
|
||
key_factors: Optional[str] = Field(default=None, alias="keyFactors")
|
||
remark: Optional[str] = Field(default=None)
|
||
|
||
|
||
class OpportunityUpdateBody(OpportunityCreateBody):
|
||
id: str = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityDeleteBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
ids: List[str] = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityAssignBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
ids: List[str] = Field(..., min_length=1)
|
||
owner_user_id: str = Field(..., alias="ownerUserId")
|
||
remark: Optional[str] = Field(default=None)
|
||
|
||
|
||
class OpportunityChangeStageBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
id: str = Field(..., min_length=1)
|
||
stage: str = Field(...)
|
||
stage_percent: int = Field(..., alias="stagePercent")
|
||
win_rate: float = Field(..., alias="winRate")
|
||
change_reason: Optional[str] = Field(default=None, alias="changeReason")
|
||
remark: Optional[str] = Field(default=None)
|
||
|
||
|
||
class OpportunityMarkWonBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
id: str = Field(..., min_length=1)
|
||
actual_deal_date: Optional[str] = Field(default=None, alias="actualDealDate")
|
||
actual_amount: Optional[float] = Field(default=None, alias="actualAmount")
|
||
remark: Optional[str] = Field(default=None)
|
||
|
||
|
||
class OpportunityMarkLostBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
id: str = Field(..., min_length=1)
|
||
lost_reason: str = Field(..., alias="lostReason")
|
||
remark: Optional[str] = Field(default=None)
|
||
competitor_info: Optional[str] = Field(default=None, alias="competitorInfo")
|
||
improvement: Optional[str] = Field(default=None)
|
||
|
||
|
||
class OpportunityBatchUpdateStageBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
ids: List[str] = Field(..., min_length=1)
|
||
stage: str = Field(...)
|
||
stage_percent: int = Field(..., alias="stagePercent")
|
||
win_rate: Optional[float] = Field(default=None, alias="winRate")
|
||
change_reason: str = Field(..., alias="changeReason")
|
||
update_expect_date: Optional[bool] = Field(default=None, alias="updateExpectDate")
|
||
notify_owner: Optional[bool] = Field(default=None, alias="notifyOwner")
|
||
|
||
|
||
class OpportunityBatchUpdateExpectDateBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
ids: List[str] = Field(..., min_length=1)
|
||
update_type: str = Field(..., alias="updateType")
|
||
expect_deal_date: Optional[str] = Field(default=None, alias="expectDealDate")
|
||
days: Optional[int] = Field(default=None)
|
||
change_reason: Optional[str] = Field(default=None, alias="changeReason")
|
||
|
||
|
||
class OpportunityStageLogListBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_id: str = Field(..., alias="opportunityId")
|
||
|
||
|
||
class OpportunityStatisticsBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
owner_user_id: Optional[str] = Field(default=None, alias="ownerUserId")
|
||
begin_time: Optional[str] = Field(default=None, alias="beginTime")
|
||
end_time: Optional[str] = Field(default=None, alias="endTime")
|
||
type: Optional[str] = Field(default="month", description="赢单率统计维度 day/week/month")
|
||
|
||
|
||
class OpportunityKanbanBody(OpportunityListBody):
|
||
pass
|
||
|
||
|
||
class OpportunityFollowListBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_id: Optional[str] = Field(default=None, alias="opportunityId")
|
||
page: int = Field(default=1, ge=1)
|
||
pageSize: int = Field(default=10, ge=1, le=500)
|
||
|
||
|
||
class OpportunityFollowDetailBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
id: str = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityFollowCreateBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_id: str = Field(..., alias="opportunityId")
|
||
follow_type: str = Field(..., alias="followType")
|
||
follow_content: str = Field(..., alias="followContent")
|
||
follow_time: Optional[str] = Field(default=None, alias="followTime")
|
||
next_time: Optional[str] = Field(default=None, alias="nextTime")
|
||
next_plan: Optional[str] = Field(default=None, alias="nextPlan")
|
||
next_content: Optional[str] = Field(default=None, alias="nextContent")
|
||
attachments: Optional[str] = Field(default=None)
|
||
remark: Optional[str] = Field(default=None)
|
||
|
||
|
||
class OpportunityFollowUpdateBody(OpportunityFollowCreateBody):
|
||
id: str = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityFollowDeleteBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
ids: List[str] = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityProductListBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_id: Optional[str] = Field(default=None, alias="opportunityId")
|
||
product_id: Optional[str] = Field(default=None, alias="productId")
|
||
page: int = Field(default=1, ge=1)
|
||
pageSize: int = Field(default=10, ge=1, le=500)
|
||
|
||
|
||
class OpportunityProductByOpportunityBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_id: Optional[str] = Field(default=None, alias="opportunityId")
|
||
id: Optional[str] = Field(default=None, description="商机ID(路径兼容)")
|
||
|
||
|
||
class OpportunityProductDetailBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
id: str = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityProductCreateBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_id: str = Field(..., alias="opportunityId")
|
||
product_id: str = Field(..., alias="productId")
|
||
product_name: Optional[str] = Field(default=None, alias="productName")
|
||
product_no: Optional[str] = Field(default=None, alias="productNo")
|
||
product_code: Optional[str] = Field(default=None, alias="productCode")
|
||
quantity: float = Field(...)
|
||
price: float = Field(...)
|
||
discount: Optional[float] = Field(default=0)
|
||
subtotal: Optional[float] = Field(default=None)
|
||
sort: Optional[int] = Field(default=0)
|
||
sort_order: Optional[int] = Field(default=None, alias="sortOrder")
|
||
remark: Optional[str] = Field(default=None)
|
||
|
||
|
||
class OpportunityProductBatchAddBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
opportunity_id: str = Field(..., alias="opportunityId")
|
||
product_list: List[OpportunityProductCreateBody] = Field(..., alias="productList")
|
||
|
||
|
||
class OpportunityProductUpdateBody(OpportunityProductCreateBody):
|
||
id: str = Field(..., min_length=1)
|
||
|
||
|
||
class OpportunityProductDeleteBody(BaseModel):
|
||
model_config = ConfigDict(populate_by_name=True)
|
||
|
||
ids: List[str] = Field(..., min_length=1)
|