@be-link/pos-cli-nodejs 0.0.31 → 0.0.32

package/src/types.ts

@@ -1,807 +0,0 @@
-import * as PosConstants from 'vitality-meta/enums/pos'
-
-/**
- * 订单正向结构
- */
-export interface IPositiveOrder {
-  /** 快照:订单ID */
-  id: string
-  /** 快照:创建时间 */
-  createdAt: number
-  /** 更新时间 */
-  updatedAt: number
-/** 订单状态 */
-  status: PosConstants.TradeOrderStatusEnum
-  /** 快照:支付时间 */
-  paidAt: number
-  /** 订单履约时间 */
-  fulfillAt: number
-  /** 履约结束时间: endOfDay(fulfillAt + T - 1) 回团日期当天的最后一秒 */
-  fulfillEndAt: number
-  /** 快照:订单完结时间 */
-  completedAt: number
-  /** 快照:订单应付金额(商品总价) */
-  originalFee: number
-  /** 快照:订单实付金额(优惠后金额) */
-  actuallyPaidFee: number
-  /** 订单剩余金额 */
-  remainFee: number
-  /** 快照:归属用户unionId */
-  unionId: string
-  /** 快照:归属用户openId */
-  openId: string
-  /** 快照:来源用户unionId */
-  fromUnionId: string
-  /** 快照:来源用户角色 */
-  fromUserRole: string
-  /** 快照:交易主商品一级类目 */
-  categoryOne: string
-  /** 快照:交易主商品二级类目 */
-  categoryTwo: string
-  /** 快照:商品归属门店ID */
-  storeId: string
-  /** 快照:交易主商品ID */
-  itemId: string
-  /** 交易主SKUID(改期场景会更新该字段) */
-  skuId: string
-  /** 快照:关联主单ID */
-  rootOrderId: string
-  /** 快照:下单场景信息 */
-  sceneInfo: {
-    /** 一级场景 */
-    scene1?: string
-    /** 二级场景 */
-    scene2?: string
-    /** 小程序场景值 */
-    appScene: number
-  }
-  /** 联系人信息 */
-  contactInfo: {
-    /** 姓名 */
-    name: string
-    /** 电话 */
-    mobile: string
-  }
-}
-
-export interface IPositiveAttributes {
-  /** 订单ID */
-  id: string
-  /** 下单时是否是会员 */
-  isMemberOrder: boolean
-  /** 是否为首次交易 */
-  isFirstTrade: boolean
-  /** 是否合并过其它订单 */
-  hasMergedOrder: boolean
-  /** 是否合并到了其它订单 */
-  isMerged: boolean
-  /** 是否修改过餐食 */
-  isMealInfoModified: boolean
-  /** 是否确认餐食信息 */
-  isMealInfoConfirmed: boolean
-  /** 是否购买过保险 */
-  isPurchasedInsurance: boolean
-  /** 服务通知是否已读 */
-  buyerWxNotificationIsRead: boolean
-  /** 服务通知是否发送 */
-  hasSentWXNotification: boolean
-  /** 是否授权服务通知 */
-  isAuthSendItineraryInfoSubscribeMessage: boolean
-  /** 出行人是否填写完整 */
-  isTouristsCompletely: boolean
-}
-
-
-export interface CostInclusionJson {
-  /** 标题 */
-  title: string
-  /** 值 */
-  value: string
-}
-
-export interface CreditInfo {
-  /** 抵扣金币 */
-  deductRate: number
-}
-export interface ItinerarySchedule {
-  /** 描述 */
-  description: any[]
-  /** 图片列表 */
-  pics: string[]
-  /** 标题 */
-  title: string
-}
-export interface Content {
-  /** 类型 */
-  type: string
-  /** 值 */
-  value: string
-}
-export interface ProductDetail {
-  /** 内容 */
-  content: Content[]
-  /** 标题 */
-  title: string
-}
-export interface SubContent {
-  /** 类型 */
-  type: string
-  /** 值 */
-  value: string
-}
-export interface PurchasingInstruction {
-  /** 内容 */
-  content: SubContent[]
-  /** 标题 */
-  title: string
-}
-
-/**
- * 订单商品快照
- */
-export interface IPositiveItemInfo {
-  /** 商品ID */
-  _id: string
-  /** 创建时间 */
-  _createTime: number
-  /** 更新时间 */
-  _updateTime: number
-  /** 取消政策 */
-  cancellationPolicy: string
-  /** 一级类目 */
-  categoryOne: string
-  /** 二级类目 */
-  categoryTwo: string
-  /** 费用不包含 */
-  costExclusion: string
-  /** 费用包含 */
-  costInclusion: any
-  /** 费用说明 */
-  costInclusionJson: CostInclusionJson[]
-  /** 金币信息 */
-  creditInfo: CreditInfo
-  /** 地接社 */
-  domesticTourOperator: string
-  /** 产品特色 */
-  featuredTags: string[]
-  /** 门店id */
-  storeId?: string
-  /** 头图 */
-  headPics: string[]
-  /** 视频 */
-  headVideo: string
-  /** 是否仅员工可见 */
-  isOnlyStaffCanSee: number
-  /** 是否自组团 */
-  isSelfLead: number
-  /** 行程安排 */
-  itinerarySchedule: ItinerarySchedule[]
-  /** 最低市场价 */
-  minMarketPrice: number
-  /** 最低会员价 */
-  minMemberPrice: number
-  /** 最低价 */
-  minPrice: number
-  /** 名称 */
-  name: string
-  /** 商品详情 */
-  productDetails: ProductDetail[]
-  /** 购买须知 */
-  purchasingInstruction: PurchasingInstruction[]
-  /** 销量 */
-  saleCount: number
-  /** 商品状态 */
-  status: string
-  /** 出发地 */
-  tourBeginPlace: string
-  /** 行程天数 */
-  tourDays: number
-  /** 目的地 */
-  tourEndPlace: string
-  /** 旅游供应商 */
-  tourWholesaler: any
-  /** 浏览次数 */
-  viewCount: number
-  /** 视频号feedId */
-  wxFeedId: string
-  /** 视频号FinderUserName */
-  wxFinderUserName: string
-  /** 合作方 */
-  cooperator: string
-  /** 酒店供应商 */
-  hotelSupplier: string
-  /** 酒店班车供应商 */
-  shuttleBusSupplier: string
-  /** 酒店班车供应商ID */
-  shuttleBusSupplierIds: string[]
-  /** 酒店班车结算价 */
-  shuttleBusSettlementPrice: number
-  /** 旅游负责人 */
-  tourPrincipal: string | null
-  /** 设施 */
-  facilities: any[]
-  /** 预定须知描述 */
-  bookingTip?: string
-  /** 有效期开始时间 */
-  periodStartTime?: number
-  /** 有效期结束时间 */
-  periodEndTime?: number
-  /** 是否可以修改餐食 */
-  canUpdateMealInfo: number | boolean
-  /** 历史商品数据，从快照原样返回 */
-  voucherInfo?: {
-    [key: string]: any
-  }
-  /**   提前预定天数(0~255) */
-  bookingDays?: number
-}
-
-export interface IPositiveSkuInfo {
-  /** SKU ID */
-  _id: string
-  /** 快照Id */
-  skuSnapShotId: string
-  /** 创建时间 */
-  _createTime: number
-  /** 更新时间 */
-  _updateTime: number
-  /** SKU 适用人群类型 */
-  applicablePeople: PosConstants.ApplicablePeopleEnum
-  /** SKU 套餐 */
-  combo?: string
-  /** SKU 费用天数 */
-  costDays?: number
-  /** SKU 出发日期 */
-  departureDate: number
-  /** SKU 显示出发日期 */
-  displayDepartureDate?: string
-  /** SKU 团信息 */
-  groupInfo?: {
-    /** 团编号 */
-    groupIdx?: number
-    /** 车牌号 */
-    carNo?: string
-    /** 领队手机号 */
-    leaderMobile?: string
-    /** 领队姓名 */
-    leaderName?: string
-    /** 团二维码 */
-    wxQrCode?: string
-    /** 返程交通(废弃，兼容历史数据) */
-    outboundTraffic?: string
-    /** 去程交通(废弃，兼容历史数据) */
-    returnTraffic?: string
-    /** 志愿者姓名 */
-    volunteerName?: string
-    /** 志愿者手机号 */
-    volunteerMobile?: string
-    /** 提示 */
-    tips?: string
-    /** 行前备注 */
-    notice: string
-    /** 提前预约(ktv,已废弃，需要兼容) */
-    bookingDays?: number
-  }
-  /** SKU 所属商品 ID */
-  itemId: string
-  /** SKU 市场价 */
-  marketPrice: number
-  /** SKU 会员价 */
-  memberPrice?: number
-  /** SKU 会员价限制次数 */
-  memberPriceLimitTimes?: number
-  /** SKU 最小订单数量 */
-  minOrderQuantity: number
-  /** SKU 计划库存 */
-  planStock: number
-  /** SKU 数量 */
-  quantity: number
-  /** SKU 相关 SKU */
-  relatedSku: string
-  /** SKU 开售时间 */
-  saleBeginTime: number
-  /** SKU 结束时间 */
-  saleEndTime: number
-  /** SKU 售价 */
-  salePrice: number
-  /** SKU 状态 */
-  status: string
-  /** SKU 剩余库存 */
-  surplus: number
-  /** SKU 结算价 */
-  settlementPrice: number
-  /** 酒店 SKU 额外信息 */
-  hotelExtraInfo?: {
-    /** SKU ID */
-    _id: string
-    /** SKU 所属商品 ID */
-    itemId: string
-    /** SKU 餐饮信息 */
-    mealInfo: string
-    /** SKU 是否有下午茶 */
-    hasAfternoonTea: number
-    /** SKU 是否有班车 */
-    hasShuttleBus: number
-  }
-  /** 剩余数量 */
-  remainQuantity: number
-  /** 一级类目 */
-  categoryOne: string
-  /** 二级类目 */
-  categoryTwo: string
-}
-
-export interface IWxPaymentInfo {
-  appId: string
-  nonceStr: string
-  package: string
-  paySign: string
-  signType: string
-  timeStamp: string
-}
-
-export interface IPositivePaymentInfo {
-  /** 支付单Id */
-  _id: string
-  /** 支付关联的交易订单ID */
-  tradeOrderId: string
-  /** 支付类型 */
-  type: PosConstants.PaymentTypeEnum
-  /** 支付工具 */
-  payTool: PosConstants.PayToolEnum
-  /** 支付总金额 */
-  totalFee: number
-  /** 外部系统中的支付交易ID */
-  outBizId: string
-  /** 支付交易的预支付ID */
-  prepayId: string
-  /** 支付关联的子商户ID */
-  subMchId?: string
-  /** 支付交易状态 */
-  tradeState: string
-  /** 支付交易状态描述 */
-  tradeStateDesc: string
-  /** 支付交易的额外信息 */
-  extraInfo?: {
-    /** 微信支付交易信息 */
-    wxPaymentInfo?: IWxPaymentInfo
-    /** 合并子单信息 */
-    tradeOrderId?: string
-    /** 外部订单 */
-    outOrderId?: string
-  }
-}
-
-export interface CouponSnapShotInfo {
-  /** 优惠券Id */
-  id: string
-  /** 优惠券的基本信息。 */
-  basicInfo: any
-  /** 优惠券的折扣规则。 */
-  discountRule: {level: string}
-  /** 与优惠券相关的任何额外信息。 */
-  extraInfo: any
-  /** 优惠券可以提供的授权类型。 */
-  grantType: string[]
-  /** 优惠券的使用范围。 */
-  scope: {type: string, value: string[]}[]
-  /** 优惠券的使用限制。 */
-  usageLimit: any
-}
-
-export interface IPositivePromotionInfo {
-  /** 营销记录Id */
-  _id: string
-  /** 订单Id */
-  tradeOrderId: string
-  /** 与营销关联的业务的唯一标识符。 */
-  bizId: string
-  /** 营销类型。 */
-  type: PosConstants.PromotionTypeEnum
-  /** 与营销关联的 SKU 列表。 */
-  skuIdList: string[]
-  /** 营销价格。 */
-  price: number
-  /** 营销应用的减免金额。 */
-  reduce: number
-  /** 与营销关联的优惠券的快照信息。 */
-  snapShotInfo: CouponSnapShotInfo
-}
-
-export interface IPositiveItineraryInfo {
-  _id: string
-  /** 人员姓名 */
-  name: string
-  /** 人员电话 */
-  phone: string
-  /** 人员身份证号 */
-  idCard: string
-  /** 行程类型 */
-  type: PosConstants.ItineraryTypeEnum
-  /** 交通工具类型 */
-  transportationType: PosConstants.TransportationTypeEnum
-  /** 出发站 */
-  departureStation: string
-  /** 集合时间 */
-  assemblyTime: number
-  /** 交通工具出发时间 */
-  transportationDepartureTime: number
-  /** 交通工具编号 */
-  serialNumber: string
-  /** 行程备注 */
-  remark: string
-  /** 座位号 */
-  seatNumber: string
-  /** 司机电话 */
-  driverPhone: string
-  /** 交易订单 ID */
-  tradeOrderId: string
-  /** 商品 ID */
-  itemId: string
-  /** SKU ID */
-  skuId: string
-  /** 出行人 ID */
-  touristId: string
-}
-
-export interface ContactInfo {
-  /** 联系人姓名 */
-  name: string
-  /** 联系人电话 */
-  mobile: string
-  /** 联系人身份证号 */
-  idCard?: string
-}
-
-export interface TouristInfo {
-  /** 出行人Id */
-  id: string
-  /** 填写人Id */
-  fillerUserId?: string
-  /** 性别 */
-  gender: number
-  /** 身份证 */
-  idCard: string
-  /** 是否自己 */
-  isSelf: number
-  /** 电话号码 */
-  mobile: string
-  /** 姓名 */
-  name: string
-  /** unionId */
-  unionId: string
-  /** 是否已通知 */
-  hasNotified?: boolean
-  /** skuId */
-  skuId?: string
-  /** 是否发送语音消息 */
-  isVoiceSucceed?: boolean
-  /** 是否发送短信 */
-  isSmsSucceed?: boolean
-}
-
-
-/** 旅游出行信息，已不再适用，兼容旧数据 */
-export interface ItineraryInfo {
-  /** 集合时间 */
-  assemblyTime: number
-  /** 出发时间 */
-  departureTime: number
-  /** 集合点 */
-  location: string
-  /** 座位号 */
-  seatNo?: string[]
-  /** 去程座位号 */
-  outboundSeatInfoDesc: string
-  /** 返程座位号 */
-  returnSeatInfoDesc: string
-  /** 行程备注 */
-  itineraryInfoNote: string
-}
-
-export interface IPositiveTouristInfo {
-  /** 订单 ID。 */
-  _id: string
-  /** 联系人(待废弃) */
-  contactInfo?: ContactInfo
-  /** 出行人列表 */
-  tourists: TouristInfo[]
-  /** 行程信息。 */
-  itineraryInfo: ItineraryInfo
-  /** 行程单已读列表 */
-  travelFormReadList: string[]
-  /** 出行人是否完整(待废弃) */
-  isTouristsCompletely: number
-  /** 服务通知已读(待废弃) */
-  buyerWxNotificationIsRead: number
-  /** 服务通知已发(待废弃) */
-  hasSentWXNotification: number
-  /** 是否授权服务通知(待废弃) */
-  isAuthSendItineraryInfoSubscribeMessage: number
-}
-
-
-export interface IPositiveFulfillmentInfo {
-  /** 履约信息Id */
-  id: string
-  /** 创建时间 */
-  createdAt: number
-  /** 更新时间 */
-  updatedAt: number
-  /** 订单 ID */
-  positiveOrderId: string
-  /** 房间信息。 */
-  roomInfo: {
-    /** 房间单人床数量。 */
-    DOUBLE_BED: {
-      count: number
-      remain: number
-    }
-    /** 房间双人床数量。 */
-    SINGLE_BED: {
-      count: number
-      remain: number
-    }
-  }
-  /** 定制餐食信息。 */
-  customMealInfo: string
-}
-
-export interface TradeOrderMergeRecordResource {
-  /** 资源类型 */
-  type: string
-  /** 合并前 */
-  before: Record<string, any>
-  /** 合并后 */
-  after: Record<string, any>
-}
-export interface IPositiveMergeRecord {
-  /** 合并记录Id */
-  _id: string
-  /** 订单Id */
-  targetId: string
-  /** 资源 */
-  resources: TradeOrderMergeRecordResource[]
-}
-
-export interface IShuttleInfo {
-  /** 班车记录Id */
-  id: string
-  /** 班车类型 */
-  type: PosConstants.ShuttleTypeEnum
-  /** 车牌号 */
-  carNo: string
-  /** 出发站 */
-  station: string
-  /** 上车时间 */
-  pickupTime: string
-  /** 司机电话 */
-  driverPhone: string
-  /** 座位号列表 */
-  seatNumbers: number[]
-  /** 订单Id */
-  tradeOrderId: string
-  /** 是否发送短信 */
-  isSendSms: number
-  /** 是否发送语音消息 */
-  isSendVoice: number
-  /** 班车供应商id */
-  shuttleBusId: string
-}
-
-export interface IPositiveNoteInfo {
-  /** 备注Id */
-  _id: string
-  /** 订单Id */
-  tradeOrderId: string
-  /** 操作人角色 */
-  operatorRole: PosConstants.OperatorRoleEnum
-  /** 操作人 */
-  operatorUser: string
-  /** 内容 */
-  content: string
-  /** 备注状态 */
-  status: PosConstants.NoteStatusEnum
-  /** 修改人角色 */
-  modifyOperatorRole?: PosConstants.ModifyOperatorRoleEnum
-  /** 修改人 */
-  modifyOperatorUser?: string
-  /** 备注类型 */
-  type: PosConstants.NoteTypeEnum
-}
-
-export interface IPositiveChangeSkuRecord {
-  /** 变更记录Id */
-  id: string
-  /** 订单id */
-  orderId: string
-  /** 操作人 */
-  operator: string
-  /** 变更原因类型 */
-  reasonType: string
-  /** 变更原因描述内容(手写) */
-  reasonDesc: string
-  /** 原skuId */
-  originalSkuId: string
-  /** 原sku出行日期 */
-  originalDepartureDate: number
-  /** 目标skuID */
-  targetSkuId: string
-  /** 目标sku出行日期 */
-  targetDepartureDate: number
-  /** 附件文件的URL列表 */
-  attachment: string[]
-}
-export interface IRawOrderStructure {
-  basicInfo: IPositiveOrder
-  attributes?: {
-    isMemberOrder: number
-    isFirstTrade: number
-    hasMergedOrder: number
-    isMerged: number
-    isMealInfoModified: number
-    isMealInfoConfirmed: number
-    isPurchasedInsurance: number
-    buyerWxNotificationIsRead: number
-    hasSentWXNotification: number
-    isAuthSendItineraryInfoSubscribeMessage: number
-    isTouristsCompletely: number
-  }
-  commodityInfo?: (IPositiveItemInfo & {skus: IPositiveSkuInfo[]})[]
-  paymentInfo?: IPositivePaymentInfo[]
-  promotionInfo?: IPositivePromotionInfo[]
-}
-export interface IRawFulFillStructure {
-  tourismInfo: IPositiveTouristInfo
-  fulfillmentInfo: IPositiveFulfillmentInfo
-}
-export interface IWxPrepayResult {
-  // 小程序端调用 wx.requestPayment 所需信息
-  payment: {
-    appId: string
-    timeStamp: string
-    nonceStr: string
-    package: string
-    signType: string
-    paySign: string
-  }
-  // 服务商商户的APPID
-  appid: string
-  // 调用接口提交的商户号
-  mch_id: string
-  // 微信分配的小程序ID
-  sub_appid: string
-  // 微信支付分配的子商户号
-  sub_mch_id: string
-  // 调用接口提交的终端设备号，
-  device_info: string
-  // 微信返回的随机字符串
-  nonce_str: string
-  // 微信返回的签名，详见签名算法
-  sign: string
-  // SUCCESS/FAIL
-  result_code: string
-  // 详细参见第6节错误列表
-  err_code: string
-  // 错误返回的信息描述
-  err_code_des: string
-
-  // 以下字段在returnCode 和result_code都为 SUCCESS 的时候有返回
-
-  // 调用接口提交的交易类型，取值如下：JSAPI
-  trade_type?: string
-  // 微信生成的预支付回话标识，用于后续接口调用中使用，该值有效期为2小时
-  prepay_id?: string
-}
-export interface IMessagePayload {
-  orderId: string
-  eventTime: number
-  operator: string
-  operatorRole: string
-  fromStatus: string
-  toStatus: string
-  unionId: string
-}
-export interface IMessageHeader {
-  categoryOne: string
-  categoryTwo: string
-}
-export interface IOrderOperatorRecord {
-  /** 订单Id */
-  tradeOrderId: string
-  /** 操作人角色 */
-  operatorRole: PosConstants.TradeOperatorRoleEnum
-  /** 操作人 */
-  operator: string
-  /** 来源状态 */
-  fromStatus: PosConstants.TradeOrderStatusEnum | null
-  /** 目的状态 */
-  toStatus: PosConstants.TradeOrderStatusEnum
-  /** 原因 */
-  reason: string
-}
-
-export interface ITradeTourismInfo {
-  /**  订单id */
-  _id: string
-  /** 订单联系人(待废弃) */
-  contactInfo: {
-    /** 姓名 */
-    name: string
-    /** 手机号 */
-    mobile: string
-  }
-  /** 出行人列表 */
-  tourists: {
-    /** 出行人Id */
-    id: string
-    /** 创建时间 */
-    _createTime: number
-    /** 更新时间 */
-    _updateTime: number
-    /** 填写人Id */
-    fillerUserId: string
-    /** 性别 */
-    gender: number
-    /** 身份证号 */
-    idCard: string
-    /** 是否本人 */
-    isSelf: number
-    /** 手机号 */
-    mobile: string
-    /** 姓名 */
-    name: string
-    /** unionId */
-    unionId: string
-    /** 是否已通知 */
-    hasNotified: boolean
-    /** skuId */
-    skuId: string
-    /** 是否语音通知成功 */
-    isVoiceSucceed: boolean
-    /** 是否短信通知成功 */
-    isSmsSucceed: boolean
-  }[]
-  /** 集合信息(废弃，兼容旧数据) */
-  itineraryInfo: {
-    /** 集合时间 */
-    assemblyTime: number
-    /** 出发时间 */
-    departureTime: number
-    /** 集合地点 */
-    location: string
-    /** 座位号 */
-    seatNo: string[]
-    /** 去程座位信息 */
-    outboundSeatInfoDesc: string
-    /** 回程座位信息 */
-    returnSeatInfoDesc: string
-    /** 行程单备注 */
-    itineraryInfoNote: string
-  }
-  /** 行程单已读 */
-  travelFormReadList: string[]
-}
-
-/**  订单查询结果和查询块的映射 */
-export interface QueryDataBlockTypeMap {
-  /** 订单Id */
-  _id: string
-  /** 主要信息 */
-  basicInfo: IPositiveOrder
-  /** 标记信息 */
-  attributes: IPositiveAttributes
-  /** 商品快照信息 */
-  itemInfo: IPositiveItemInfo[]
-  /** sku快照信息 */
-  skuInfo: IPositiveSkuInfo[]
-  /** 支付信息 */
-  paymentInfo: IPositivePaymentInfo[]
-  /** 营销信息 */
-  promotionInfo: IPositivePromotionInfo[]
-}
-
-/**  订单查询结果 */
-export type QueryDataRes<K extends (keyof QueryDataBlockTypeMap)[]> = {
-  [key in K[number]]: QueryDataBlockTypeMap[key]
-}