front/src/api/interface-trackWarning/typings.d.ts

759 lines
20 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

declare namespace API {
type AddRuleAreaInfoRequest = {
/** 国家二字码,必填项。 */
countryCode: string;
/** 国家名称 */
countryName: string;
/** 省份名称,可为空。 */
province?: string;
/** 城市名称,可为空。 */
city?: string;
/** 左侧邮政编码,可为空。 */
leftPostCode?: string;
/** 右侧邮政编码,可为空。 */
rightPostCode?: string;
/** 区域ID,必填项。 */
areaId: number;
};
type AreaDto = {
/** 区域id */
id?: number;
/** 子系统id */
subSystemId?: number;
/** 系统名称 */
systemName?: string;
/** 区域名称 */
name?: string;
/** 更新时间 */
updateTime?: string;
};
type AreaDtoUnifyPageResultDto = {
pagination?: PageInfoOutput;
list?: AreaDto[];
};
type CompleteWarningDetailsDto = {
/** 预警明细唯一id */
esId?: string;
/** 子系统id */
subSystemId?: number;
/** 子系统名称 */
subSystemName?: string;
/** 订单类型 */
orderType?: number;
/** 订单类型名称 */
orderTypeName?: string;
/** 订单id */
orderId?: number;
/** 订单号 */
orderNo?: string;
/** 状态 (待处理样式标红)
1:待处理,2:已处理,3:已关闭 */
status?: number;
/** 客户id */
customId?: number;
/** 客户简称 */
customName?: string;
/** 缺失轨迹状态 e.g [ {1:"状态1",2:"状态2"} , {3:"状态3",4:"状态4"} ] */
missingTrackStatus?: RequireTrackStatusItem[];
/** 最新轨迹状态 */
latestTrackStatus?: string;
/** 最新轨迹内容 */
latestTrackContent?: string;
/** 最新轨迹发生地 */
latestTrackPlace?: string;
/** 最新轨迹发生时间 */
latestTrackTime?: string;
/** 最新轨迹发生时区 e.g GMT +8:00 / -- */
latestTrackTimeZone?: string;
/** 通知对象 */
notifyUserNames?: string;
/** 预警创建时间 */
createTime?: string;
/** 预警处理时间 */
processedTime?: string;
};
type CompleteWarningDetailsDtoUnifyPageResultDto = {
pagination?: PageInfoOutput;
list?: CompleteWarningDetailsDto[];
};
type CompleteWarningRuleItemDto = {
/** 配置条目唯一id */
id?: number;
/** 预警规则主体id */
warningId?: number;
/** 订单类型 e.g FBA订单、海运单 */
orderTypes?: OrderTypeDto[];
/** 检查点轨迹状态id */
checkPointTrackStatusId?: number;
/** 检查点轨迹状态 */
checkPointTrackStatus?: string;
/** 要求的轨迹状态集合 e.g [揽收/入库中],[提交报关] */
requireTrackStatus?: RequireTrackStatusItem[];
/** 通知对象用户集合 */
notifyUsers?: NotifyUserDto[];
};
type CompleteWarningRuleItemDtoListUnifyResultDto = {
code?: string;
msg?: string;
data?: CompleteWarningRuleItemDto[];
};
type CreateRuleAreaRequest = {
/** 系统id */
systemId: number;
/** 名称 */
name: string;
};
type DeleteTransportWarningSceneInput = {
/** 场景唯一id */
id?: number;
/** 预警规则主体id */
warningId?: number;
};
type EditCompleteWarningRuleItemDto = {
/** 规则项目唯一id(传0视为新增) */
id?: number;
/** 订单类型集合(,分割) e.g. 1,2,3 */
orderTypes: string;
/** 检查点轨迹状态id */
checkPointTrackStatusId?: number;
/** 要求的轨迹状态id集合 e.g. [[1,3],[5,7]]
required: 集合元素(子集合)不要有交集! */
requireTrackStatus: number[][];
/** 通知对象用户集合 */
notifyUsers: NotifyUserDto[];
};
type EditCompleteWarningRuleItemInput = {
/** 预警规主体id */
warningId?: number;
/** 预警规则配置项目(列表内容传递) */
items?: EditCompleteWarningRuleItemDto[];
};
type EditReturnWarningRuleItemDto = {
/** 唯一id(传0视为新增) */
id?: number;
/** 轨迹状态Id集合(,分割) */
trackStatusIds: string;
/** 时效(单位h) */
returnTimeSpan?: number;
/** 通知对象用户集合 */
notifyUsers?: NotifyUserDto[];
};
type EditReturnWarningRuleItemInput = {
/** 预警规主体id */
warningId?: number;
/** 预警规则配置项目(列表内容传递) */
items?: EditReturnWarningRuleItemDto[];
};
type EditTransportWarningSceneRuleItemDto = {
/** 规则项目id(传0视为新增) */
id?: number;
/** 起始轨迹状态Id */
startTrackStatusId?: number;
/** 截止轨迹状态Id */
endTrackStatusId?: number;
/** 时效 (单位h)
注意:需要大于起始轨迹生成预警时间 */
transportTimeSpan?: number;
/** 起始轨迹生成预警时间 (单位h) */
startTrackWarningTimeSpan?: number;
/** 通知对象用户集合 */
notifyUsers?: NotifyUserDto[];
};
type EditTransportWarningSceneRuleItemInput = {
/** 预警规主体id */
warningId?: number;
/** 运输预警场景id */
sceneId?: number;
/** 预警规则配置项目(列表内容传递) */
items?: EditTransportWarningSceneRuleItemDto[];
};
type GetCompleteWarningRuleItemInput = {
/** 规则主体id */
warningId?: number;
};
type GetPageCompleteWarningDetailsInput = {
pageIndex?: number;
pageSize?: number;
/** 子系统id */
subSystemId?: number;
/** 订单号,限制1000个 */
orderNos?: string[];
/** 订单类型 */
orderType?: number;
/** 状态
1:待处理,2:已处理,3:已关闭 */
status?: number;
/** 客户id */
customId?: number;
/** 缺失轨迹状态id */
missingTrackStatusId?: number;
/** 通知对象id */
notifyUserId?: number;
/** 预警创建时间开始 */
warningCreateTimeStart?: string;
/** 预警创建时间截止 */
warningCreateTimeEnd?: string;
/** 预警处理时间开始 */
warningHandleTimeStart?: string;
/** 预警处理时间截止 */
warningHandleTimeEnd?: string;
};
type GetPageReturnWarningDetailsInput = {
pageIndex?: number;
pageSize?: number;
/** 子系统id */
subSystemId?: number;
/** 订单号,限制1000个 */
orderNos?: string[];
/** 订单类型 */
orderType?: number;
/** 状态
1:人工介入 2:重试中 3:推送完成 4:已关闭 */
status?: number;
/** 客户id */
customId?: number;
/** 轨迹状态id */
trackStatusId?: number;
/** 轨迹内容id */
trackContentId?: number;
/** 是否有Kpi考核 (传null为查全部) */
isKpi?: boolean;
/** 通知对象用户id */
notifyUserId?: number;
/** 轨迹发生时间开始 */
trackTimeStart?: string;
/** 轨迹发生时间截止 */
trackTimeEnd?: string;
/** 轨迹创建时间开始 */
trackCreateTimeStart?: string;
/** 轨迹创建时间截止 */
trackCreateTimeEnd?: string;
/** 轨迹回传时间开始 */
trackReturnTimeStart?: string;
/** 轨迹回传时间截止 */
trackReturnTimeEnd?: string;
/** 预警创建时间开始 */
warningCreateTimeStart?: string;
/** 预警创建时间截止 */
warningCreateTimeEnd?: string;
};
type GetPageTransportWarningDetailsInput = {
pageIndex?: number;
pageSize?: number;
/** 子系统id */
subSystemId?: number;
/** 订单号,限制1000个 */
orderNos?: string[];
/** 订单类型 */
orderType?: number;
/** 状态 */
status?: number;
/** 客户Id */
customId?: number;
/** 预警名称 */
warningName?: string;
/** 通知对象用户Id */
notifyUserId?: number;
/** 创建时间开始 */
createTimeStart?: string;
/** 创建时间截止 */
createTimeEnd?: string;
};
type GetReturnMessageRecordInput = {
/** 回传预警明细id */
warningDetailsId: string;
};
type GetReturnWarningRuleItemInput = {
/** 规则主体id */
warningId?: number;
};
type GetTransportWarningSceneInput = {
/** 预警主体id */
warningId?: number;
};
type GetTransportWarningSceneRuleItemInput = {
/** 预警主体id */
warningId?: number;
/** 运输预警场景id */
sceneId?: number;
};
type GetWarningRuleInput = {
/** 子系统id */
subSystemId?: number;
/** kpi名称 模糊查询 */
kpiName?: string;
/** 客户id */
customId?: number;
/** 是否启用(留null查全部) */
isEnabled?: boolean;
/** 预警类型(留null查所有类型)
1:运输时效,2:回传时效,3:完整预警 */
warningType?: number;
};
type IdBaseDto = {
id?: number;
};
type IdBaseDtoUnifyResultDto = {
code?: string;
msg?: string;
data?: IdBaseDto;
};
type KpiAreaDeleteKpiAreaDELETEParams = {
/** 分区id */
id?: number;
};
type KpiAreaDeleteKpiAreaInfoDELETEParams = {
/** 分区信息id */
id?: number;
};
type NotifyUserDto = {
/** 用户id */
userId?: number;
/** 用户名 */
userName: string;
};
type OrderTypeDto = {
/** 订单类型 */
orderType?: number;
/** 订单类型名称 */
orderTypeName?: string;
};
type PageInfoOutput = {
pageIndex?: number;
pageSize?: number;
total?: number;
};
type QueryAreaInfoRequest = {
pageIndex?: number;
pageSize?: number;
/** 区域id */
areaId?: number;
};
type QueryAreaRequest = {
pageIndex?: number;
pageSize?: number;
/** 分区名称 */
name?: string;
/** 子系统id */
systemId?: number;
};
type RemoteServiceErrorInfo = {
code?: string;
message?: string;
details?: string;
data?: Record<string, any>;
validationErrors?: RemoteServiceValidationErrorInfo[];
};
type RemoteServiceErrorResponse = {
error?: RemoteServiceErrorInfo;
};
type RemoteServiceValidationErrorInfo = {
message?: string;
members?: string[];
};
type RequireTrackStatusItem = {
/** 轨迹状态集合 */
statuses?: TrackStatusDto[];
};
type ReturnMessageRecordDto = {
/** 回传报文唯一id */
esId?: string;
/** 回传预警明细ids
一次回传可能产生多条预警信息,但它们的回传报文都相同 */
returnWarningDetailsIds?: string;
/** 是否成功 */
isSuccess?: boolean;
/** 报文内容 Json字符串 */
message?: string;
/** 报文创建时间 */
createTime?: string;
};
type ReturnMessageRecordDtoListUnifyResultDto = {
code?: string;
msg?: string;
data?: ReturnMessageRecordDto[];
};
type ReturnPushInput = {
/** 预警明细ids 最多100个 */
warningDetailIds?: string[];
};
type ReturnWarningDetailsDto = {
/** 预警明细唯一id */
esId?: string;
/** 子系统id */
subSystemId?: number;
/** 子系统名称 */
subSystemName?: string;
/** 订单类型 */
orderType?: number;
/** 订单类型名称 */
orderTypeName?: string;
/** 订单id */
orderId?: number;
/** 订单号 */
orderNo?: string;
/** 状态 1:人工介入 2:重试中 3:推送完成 4:已关闭 */
status?: number;
/** 客户id */
customId?: number;
/** 客户简称 */
customName?: string;
/** 轨迹状态 */
trackStatus?: string;
/** 轨迹代码 */
trackCode?: string;
/** 轨迹内容 */
trackContent?: string;
/** 推送轨迹代码 */
pushTrackCode?: string;
/** 推送轨迹状态 */
pushTrackStatus?: string;
/** 推送轨迹内容 */
pushTrackContent?: string;
/** 轨迹发生地 */
trackPlace?: string;
/** 轨迹发生时间 */
trackTime?: string;
/** 轨迹发生时区 e.g GMT +8:00 / -- */
trackTimeZone?: string;
/** 轨迹创建时间 */
trackCreateTime?: string;
/** 轨迹回传时间 */
trackReturnTime?: string;
/** 回传时效 (单位h) */
returnTimeSpan?: number;
/** 实际回传用时(单位毫秒)e.g 00天00小时00分钟 / -- */
actualReturnTimeSpan?: string;
/** 系统回传用时(单位毫秒)e.g 00天00小时00分钟 / -- */
systemReturnTimeSpan?: string;
/** 轨迹创建用时(单位毫秒)e.g 00天00小时00分钟 / -- */
trackCreateTimeSpan?: string;
/** 是否超时,只有命中了kpi考核的才有可能超时
如果为超时则标红【实际回传】字段 */
isTimeout?: boolean;
/** 是否有KPI考核 */
isExistsKpi?: boolean;
/** 回传重试次数 */
retryCount?: number;
/** 通知对象 (未命中kpi考核一定不存在通知人) */
notifyUserNames?: string;
/** 预警创建时间 */
createTime?: string;
};
type ReturnWarningDetailsDtoUnifyPageResultDto = {
pagination?: PageInfoOutput;
list?: ReturnWarningDetailsDto[];
};
type ReturnWarningRuleItemDto = {
/** 规则项目唯一 id */
id?: number;
/** 轨迹状态 */
trackStatus?: TrackStatusDto[];
/** 时效(单位h) */
returnTimeSpan?: number;
/** 通知对象 */
notifyUsers?: NotifyUserDto[];
};
type ReturnWarningRuleItemDtoListUnifyResultDto = {
code?: string;
msg?: string;
data?: ReturnWarningRuleItemDto[];
};
type RuleAreaInfoDto = {
/** 分区信息id */
id?: number;
/** 分区id */
areaId?: number;
/** 国家或地区 二字码 */
countryCode?: string;
/** 国家名称 */
countryName?: string;
/** 国家id */
countryId?: number;
/** 省份 */
province?: string;
/** 城市 */
city?: string;
/** 开始邮编 */
leftPostcode?: string;
rightPostcode?: string;
};
type RuleAreaInfoDtoUnifyPageResultDto = {
pagination?: PageInfoOutput;
list?: RuleAreaInfoDto[];
};
type TrackStatusDto = {
/** 轨迹状态id */
trackStatusId?: number;
/** 轨迹状态名称 */
trackStatus?: string;
};
type TransportWarningDetailsDto = {
/** 预警明细唯一id */
esId?: string;
/** 子系统id */
subSystemId?: number;
/** 子系统名称 */
subSystemName?: string;
/** 客户id */
customId?: number;
/** 客户简称 */
customName?: string;
/** 订单id */
orderId?: number;
/** 订单号 */
orderNo?: string;
/** 订单类型 */
orderType?: number;
/** 订单类型名称 */
orderTypeName?: string;
/** 最新轨迹内容 */
latestTrackContent?: string;
/** 最新轨迹时间 */
latestTrackTime?: string;
/** 最新轨迹发生时区 e.g GMT +8:00 / -- */
latestTrackTimeZone?: string;
/** 最新轨迹发生地 */
latestTrackPlace?: string;
/** 通知对象 */
notifyUserNames?: string;
/** 起始轨迹状态 */
startTrackStatus?: string;
/** 起始轨迹内容 */
startTrackContent?: string;
/** 起始轨迹发生时间 */
startTrackTime?: string;
/** 起始轨迹时区 e.g GMT +8:00 / -- */
startTrackTimeZone?: string;
/** 截止轨迹状态 */
endTrackStatus?: string;
/** 截止轨迹内容 */
endTrackContent?: string;
/** 截止轨迹发生时间 */
endTrackTime?: string;
/** 截止轨迹时区 e.g GMT +8:00 / -- */
endTrackTimeZone?: string;
/** 预警名称 (预警主体名称 如字节全程时效) */
warningName?: string;
/** 预警规则描述(用于tooltip展示) */
warningRuleDescription?: string;
/** 累计运输时间 */
cumulativeTimeSpan?: string;
/** 预警状态 (根据key展示对应名称,即将超时需要标红)
1:即将超时 2:已超时 3:已完成 4:超时完成 5:已关闭,初始为【即将超时】 */
status?: number;
/** 预警创建时间 */
createTime?: string;
};
type TransportWarningDetailsDtoUnifyPageResultDto = {
pagination?: PageInfoOutput;
list?: TransportWarningDetailsDto[];
};
type TransportWarningSceneDto = {
/** 场景唯一id */
id?: number;
/** 预警规则主体id */
warningId?: number;
/** 场景摘要(用于展示场景tabs) */
summary?: string;
/** 是否中转(单一) */
isTransit?: boolean;
/** 货物类型(多个,分割) */
cargoType?: string;
/** 起运港口(多个,分割) */
leavePort?: string;
/** 产品编码(多个,分割) */
productCode?: string;
/** 月份(多个/分割) */
months?: string;
/** 区域Id(单一) */
areaId?: number;
/** 区域id对应的名称 */
areaName?: string;
};
type TransportWarningSceneDtoListUnifyResultDto = {
code?: string;
msg?: string;
data?: TransportWarningSceneDto[];
};
type TransportWarningSceneRuleItemDto = {
/** 规则项目唯一id */
id?: number;
/** 起始轨迹状态Id */
startTrackStatusId?: number;
/** 起始轨迹状态 */
startTrackStatus?: string;
/** 截止轨迹状态Id */
endTrackStatusId?: number;
/** 截止轨迹状态 */
endTrackStatus?: string;
/** 时效 (单位h) */
transportTimeSpan?: number;
/** 起始轨迹生成预警时间 (单位h) */
startTrackWarningTimeSpan?: number;
/** 通知对象用户集合 */
notifyUsers?: NotifyUserDto[];
};
type TransportWarningSceneRuleItemDtoListUnifyResultDto = {
code?: string;
msg?: string;
data?: TransportWarningSceneRuleItemDto[];
};
type UnifyResultDto = {
code?: string;
msg?: string;
data?: any;
};
type UpdateEnabledStatusInput = {
/** 预警主体id */
warningId?: number;
/** 预警类型,1:运输时效,2:回传时效,3:完整预警 */
warningType?: number;
/** 启用状态 */
isEnabled: boolean;
};
type UpdateRuleAreaInfoRequest = {
/** 区域信息ID */
id?: number;
/** 国家二字码,必填项。 */
countryCode: string;
/** 国家名称,必填项。 */
countryName: string;
/** 省份名称,可为空。 */
province?: string;
/** 城市名称,可为空。 */
city?: string;
/** 左侧邮政编码,可为空。 */
leftPostCode?: string;
/** 右侧邮政编码,可为空。 */
rightPostCode?: string;
};
type UpdateRuleAreaRequest = {
/** 名称 */
name: string;
/** 区域id */
id?: number;
};
type UpsertTransportWarningSceneInput = {
/** 场景唯一id (传0视为新增) */
id?: number;
/** 预警规则主体id */
warningId?: number;
/** 是否中转(单一) */
isTransit?: boolean;
/** 货物类型(多个,分割) */
cargoType?: string;
/** 起运港口(多个,分割) */
leavePort?: string;
/** 产品编码(多个,分割) */
productCode?: string;
/** 月份(多个/分割) */
months?: string;
/** 区域Id(单一) */
areaId?: number;
};
type UpsertWarningRuleInput = {
/** 唯一id(传0视为新增) */
id?: number;
/** 子系统id */
subSystemId?: number;
/** 客户id */
customId?: number;
/** 预警规则名称 */
name: string;
/** 是否启用 */
isEnabled: boolean;
/** 预警类型,1:运输时效,2:回传时效,3:完整预警 */
warningType?: number;
};
type WarningRuleDto = {
/** 规则主体唯一id */
id?: number;
/** 子系统id */
subSystemId?: number;
/** 子系统名称 */
subSystemName?: string;
/** 客户id */
customId?: number;
/** 客户简称 */
customName?: string;
/** 预警规则名称 */
name?: string;
/** 是否启用 */
isEnabled?: boolean;
/** 预警类型,1:运输时效,2:回传时效,3:完整预警 */
warningType?: number;
/** 规则版本,用于标识规则产物(如预警信息) */
version?: string;
/** 创建时间 */
createTime?: string;
/** 更新时间 */
updateTime?: string;
};
type WarningRuleDtoListUnifyResultDto = {
code?: string;
msg?: string;
data?: WarningRuleDto[];
};
}