Options
All
  • Public
  • Public/Protected
  • All
Menu

Module service/member

Index

Enumerations

Type aliases

Functions

Type aliases

ActionBase

ActionBase: { createTime: string; id: string; memberId: string; updateTime: string } & AddActionBaseOptions

行为记录的信息

ActionRecordsType

ActionRecordsType: { 下载: "资料下载"; 浏览: "观看记录"; 通知: "首次提醒" }

行为记录的Type与Value

description

规范参见：https://www.tapd.cn/55958943/markdown_wikis/show/#1155958943001000526

Type declaration

  • 下载: "资料下载"
  • 浏览: "观看记录"
  • 通知: "首次提醒"

ActionStatusesType

ActionStatusesType: { 学习: "课程"; 点赞: "视频点赞"; 预约: "课程预约" | "直播报名" }

行为状态的Type与Value

description

规范参见：https://www.tapd.cn/55958943/markdown_wikis/show/#1155958943001000566

Type declaration

  • 学习: "课程"
  • 点赞: "视频点赞"
  • 预约: "课程预约" | "直播报名"

AddActionBaseOptions

AddActionBaseOptions<T>: { key?: string; more?: { path: string }; name: string; type: keyof T; uaId?: string; value: T[keyof T] }

记录行为的提交内容主体

description

规范参见：https://www.tapd.cn/55958943/markdown_wikis/show/#1155958943001000526

Type parameters

  • T = Record<string, string>

Type declaration

  • Optional key?: string

    用做系统微站id

  • Optional more?: { path: string }
    • [key: string]: undefined | string
    • path: string

      行为触发时的路径

  • name: string

    行为的具体名称

  • type: keyof T

    行为类型

  • Optional uaId?: string

    uaid

  • value: T[keyof T]

    子类型

Address

Address: { city?: string; country?: string; details?: string; district?: string; province?: string }

地址信息

Type declaration

  • Optional city?: string
  • Optional country?: string
  • Optional details?: string

    详细地址

  • Optional district?: string
  • Optional province?: string

BookMark

BookMark<T>: { detail?: { banner?: string; dataHierarchy?: string; dataRowId?: string; desc?: string; sort?: string } & T; name: string; uaId: string; url: string }

收藏信息

Type parameters

  • T: Record<string, string> = Record<string, string>

Type declaration

  • Optional detail?: { banner?: string; dataHierarchy?: string; dataRowId?: string; desc?: string; sort?: string } & T
  • name: string

    收藏名称

  • uaId: string
  • url: string

    收藏页的url

BookMarkList

BookMarkList: BookMark[]

收藏列表

BookMarkResponse

BookMarkResponse: BookMark & { createTime: string; id: string; memberId: string }

接口返回的收藏信息

FormSetting

FormSetting: { manualQualification: boolean; memberApplicationSetting: { formIds: string[]; isMember: boolean; membershipLevel: Level }; membershipLevel: Level; submitForm: boolean; subscribeOfficialAccount: boolean }

成为会员的设置

description

在后台会员中心的会员体系设置

Type declaration

  • manualQualification: boolean
  • memberApplicationSetting: { formIds: string[]; isMember: boolean; membershipLevel: Level }

    表单设置

    • formIds: string[]
    • isMember: boolean
    • membershipLevel: Level
  • membershipLevel: Level
  • submitForm: boolean

    是否需要提交表单

  • subscribeOfficialAccount: boolean

    是否需要关注公众号

FormSettings

FormSettings: FormSetting[]

所有会员等级的表单设置

GetActionBaseOptions

GetActionBaseOptions<T>: Partial<{ desc: boolean; from: string; key: string; to: string; types: keyof T[]; uaId: string; value: T[keyof T] }>

行为记录的查询参数

Type parameters

  • T: Record<string, string>

Gift

Gift: { availableFrom: string; availableTo: string; hasAvailableTime: boolean; hasTag: boolean; id: string; isAvailable: boolean; isVirtual: boolean; membershipLevelLimit?: Level["level"]; name: string; orderIndex: string; photoUrl: string; pointsCost: string; redeemTimesLimit: string; remainingRedeemTimes: string; remark: string; stock: string; tag: string }

礼品信息

Type declaration

  • availableFrom: string

    兑换开始时间

  • availableTo: string

    兑换结束时间

  • hasAvailableTime: boolean

    是否有兑换时间

  • hasTag: boolean

    是否展示标签

  • id: string
  • isAvailable: boolean

    是否上架

  • isVirtual: boolean

    是否是虚拟礼品

  • Optional membershipLevelLimit?: Level["level"]

    兑换权限

  • name: string
  • orderIndex: string

    订单索引

  • photoUrl: string

    图片

  • pointsCost: string

    消耗积分数

  • redeemTimesLimit: string

    兑换上限

  • remainingRedeemTimes: string

    个人兑换上限

  • remark: string

    备注

  • stock: string

    库存数量

  • tag: string

    标签名称

GiftList

GiftList: Gift[]

礼品信息列表

Level

Level: { level: "1" | "2"; levelName: string }

会员等级

Type declaration

  • level: "1" | "2"
  • levelName: string

MemberInfo

MemberInfo: { address: Address; company?: string; department?: string; id: string; industry?: string; mailbox?: string; membershipLevel: Level; openId: string; personName: { firstName?: string; fullName?: string; lastName?: string }; phone?: string; points: string; position?: string; registrationTime: string; updateTime: string }

会员信息

Type declaration

  • address: Address

    地址

  • Optional company?: string

    公司

  • Optional department?: string

    部门

  • id: string
  • Optional industry?: string

    行业

  • Optional mailbox?: string

    邮箱

  • membershipLevel: Level
  • openId: string
  • personName: { firstName?: string; fullName?: string; lastName?: string }

    姓名

    description

    包括姓/名

    • Optional firstName?: string
    • Optional fullName?: string
    • Optional lastName?: string
  • Optional phone?: string

    手机

  • points: string

    当前积分数

  • Optional position?: string

    职位

  • registrationTime: string

    注册时间

  • updateTime: string

Order

Order: { createTime: string; giftRecords: VirtualGift[]; id: string; memberId: string; orderNumber: string; productId: string; productIsVirtual: boolean; productName: string; productPhotoUrl: string; recipientAddress: Address; recipientId: string; recipientName: string; recipientPhone: string; redeemAmount: string; remark: string; status: { carrier?: string; isShipped: boolean; orderState: OrderState; trackingNumber?: string }; totalPointCost: string }

订单信息

Type declaration

  • createTime: string
  • giftRecords: VirtualGift[]

    虚拟礼品的卡号/卡密

  • id: string
  • memberId: string
  • orderNumber: string

    订单号

  • productId: string
  • productIsVirtual: boolean

    是否为虚拟礼品

  • productName: string
  • productPhotoUrl: string
  • recipientAddress: Address
  • recipientId: string
  • recipientName: string
  • recipientPhone: string
  • redeemAmount: string

    兑换数量

  • remark: string
  • status: { carrier?: string; isShipped: boolean; orderState: OrderState; trackingNumber?: string }

    发货状态

    • Optional carrier?: string

      物流方

    • isShipped: boolean

      是否发货

    • orderState: OrderState

      订单状态

    • Optional trackingNumber?: string

      物流单号

  • totalPointCost: string

    消耗的积分数

OrderInput

OrderInput: { productId: string; recipientId?: string; redeemAmount: number; remark?: string }

订单提交时的参数

description

虚拟礼品兑换不需要收获信息

Type declaration

  • productId: string

    礼品id

  • Optional recipientId?: string

    收获信息id

  • redeemAmount: number

    兑换数量

  • Optional remark?: string

    兑换备注

OrderList

OrderList: Order[]

订单信息列表

Recipient

Recipient: { address: Required<Address>; createTime: string; id: string; isDefault: boolean; name: string; phone: string; updateTime: string }

收货信息

Type declaration

  • address: Required<Address>
  • createTime: string
  • id: string
  • isDefault: boolean

    是否为默认地址

  • name: string

    收货人姓名

  • phone: string

    收货人手机

  • updateTime: string

RecipientList

RecipientList: Recipient[]

收货信息列表

RecordList

RecordList: { action: "Add" | "Reduce"; createTime: string; eventCategory: string; eventId: string; eventKey: string; eventMore?: Partial<BaseActionData & { title: string }>; id: string; memberId: string; pointChange: string; remark: string; sourceType: PointRecodsType }[]

积分记录列表

StoreSetting

StoreSetting: { acquirePointsAuth: Level; redeemProductAuth: Level }

积分的获取兑换设置

description

在系统后台的积分规则处配置

Type declaration

  • acquirePointsAuth: Level

    积分获取权限

  • redeemProductAuth: Level

    礼品兑换权限

VirtualGift

VirtualGift: { giftCard: string; giftId: string; giftKey: string }

虚拟礼品信息

description

虚拟礼品兑换不需要收获信息，兑换后可以通过接口拿到卡号/卡密

Type declaration

  • giftCard: string
  • giftId: string
  • giftKey: string

VirtualGiftList

VirtualGiftList: VirtualGift[]

虚拟礼品信息列表

Functions

Const AddActionStatus

Const DelActionStatus

  • DelActionStatus(statusIds: string[]): Promise<void>

  • 删除行为状态

    Parameters

    • statusIds: string[]

    Returns Promise<void>

Const UpdateActionStatus

Const addActionRecord

Const addBookmark

  • addBookmark(params: Partial<Pick<BookMark<Record<string, string>>, "uaId" | "url">> & Omit<BookMark<Record<string, string>>, "uaId" | "url">): Promise<BookMarkResponse>

  • 添加收藏

    description

    uaid和url默认为全局配置

    Parameters

    • params: Partial<Pick<BookMark<Record<string, string>>, "uaId" | "url">> & Omit<BookMark<Record<string, string>>, "uaId" | "url">

    Returns Promise<BookMarkResponse>

Const checkMember

  • checkMember(): Promise<boolean>

  • 是否是会员

    Returns Promise<boolean>

Const delActionRecord

  • delActionRecord(recordIds: string[]): Promise<void>

  • 删除行为记录

    Parameters

    • recordIds: string[]

    Returns Promise<void>

Const deleteBookmark

  • deleteBookmark(bookmarkId: string): Promise<void>

  • 取消收藏

    Parameters

    • bookmarkId: string

    Returns Promise<void>

Const deleteRecipient

  • deleteRecipient(recipientId: string): Promise<void>

  • 删除收货地址

    Parameters

    • recipientId: string

    Returns Promise<void>

Const eraseMember

  • eraseMember(shouldEraseLead?: boolean): Promise<void>

  • 删除会员资料

    Parameters

    • shouldEraseLead: boolean = false

    Returns Promise<void>

Const getActionRecords

  • getActionRecords(__namedParameters: ListPagination & { desc?: boolean } & { options: Partial<{ desc: boolean; from: string; key: string; to: string; types: keyof ActionRecordsType[]; uaId: string; value: "观看记录" | "资料下载" | "首次提醒" }> }): ListResponse<ActionBase[], unknown>

  • 获取行为记录

    Parameters

    • __namedParameters: ListPagination & { desc?: boolean } & { options: Partial<{ desc: boolean; from: string; key: string; to: string; types: keyof ActionRecordsType[]; uaId: string; value: "观看记录" | "资料下载" | "首次提醒" }> }

    Returns ListResponse<ActionBase[], unknown>

Const getActionStatuses

  • getActionStatuses(__namedParameters: ListPagination & { desc?: boolean } & { options: Partial<{ desc: boolean; from: string; key: string; to: string; types: keyof ActionStatusesType[]; uaId: string; value: "视频点赞" | "课程预约" | "直播报名" | "课程" }> } & { status?: ActionStatus }): ListResponse<({ createTime: string; id: string; memberId: string; updateTime: string } & AddActionBaseOptions<Record<string, string>> & { status: ActionStatus })[], unknown>

  • 获取行为状态

    Parameters

    • __namedParameters: ListPagination & { desc?: boolean } & { options: Partial<{ desc: boolean; from: string; key: string; to: string; types: keyof ActionStatusesType[]; uaId: string; value: "视频点赞" | "课程预约" | "直播报名" | "课程" }> } & { status?: ActionStatus }

    Returns ListResponse<({ createTime: string; id: string; memberId: string; updateTime: string } & AddActionBaseOptions<Record<string, string>> & { status: ActionStatus })[], unknown>

Const getBookmarks

Const getMemberInfo

  • getMemberInfo(include?: boolean): Promise<MemberInfo>

  • 会员信息

    description

    默认不包含积分记录/收藏信息

    Parameters

    • include: boolean = false

    Returns Promise<MemberInfo>

Const getMembershipLevelSettings

  • 获取成为会员的表单设置

    Returns Promise<FormSettings>

Const getOrders

  • 获取订单记录

    description

    筛选：支持通过发货状态； 排序：创建时间

    Parameters

    Returns ListResponse<OrderList, unknown>

Const getPointRecords

  • 获取积分记录

    description

    筛选：支持通过时间区间和积分id； 排序：创建时间

    Parameters

    Returns ListResponse<RecordList, unknown>

Const getPointStoreSetting

  • 获取积分商城设置

    Returns Promise<StoreSetting>

Const getProduct

  • getProduct(productId: string): Promise<Gift>

  • 礼品详情

    Parameters

    • productId: string

    Returns Promise<Gift>

Const getProductCostRange

  • getProductCostRange(): Promise<{ max: string; min: string }>

  • 礼品积分范围

    Returns Promise<{ max: string; min: string }>

Const getProducts

  • getProducts(params: { costFrom?: null | number; costTo?: null | number; isAvailable?: boolean; orderByCostDesc?: null | boolean } & ListPagination): ListResponse<GiftList, unknown>

  • 礼品列表

    description

    筛选：上架/积分区间；排序：积分大小

    Parameters

    • params: { costFrom?: null | number; costTo?: null | number; isAvailable?: boolean; orderByCostDesc?: null | boolean } & ListPagination

    Returns ListResponse<GiftList, unknown>

Const getRecipient

  • getRecipient(recipientId: string): Promise<Recipient>

  • 收货地址详情

    Parameters

    • recipientId: string

    Returns Promise<Recipient>

Const getRecipients

memberApi

  • memberApi(target: string, data?: any): Promise<any>

Const placeOrder

  • 兑换礼品

    description

    虚拟礼品兑换不需要收获信息

    Parameters

    Returns Promise<Order>

Const requestGift

  • 获取虚拟礼品兑换码

    Parameters

    • orderId: string

    Returns Promise<VirtualGiftList>

Const setDefaultRecipient

  • setDefaultRecipient(recipientId: string): Promise<void>

  • 设置默认收货地址

    Parameters

    • recipientId: string

    Returns Promise<void>

Const updateMember

  • 更新会员信息

    description

    默认只更新传入的参数

    Parameters

    • input: Partial<MemberInfo>
    • isPartialUpdate: boolean = true

    Returns Promise<MemberInfo>

Const updateRecipient

  • 更改/新增收货地址

    Parameters

    Returns Promise<MemberInfo>

Generated using TypeDoc