@satorijs/adapter-dingtalk 2.0.3 → 2.0.5

package/src/api/rooms.ts

@@ -0,0 +1,334 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface QueryDevicePropertiesParams {
+  /** 设备属性名称列表，最大值10。 */
+  propertyNames?: string[]
+}
+
+export interface QueryDevicePropertiesQuery {
+  /** 操作查询的人员unionId，可调用[查询用户详情](https://open.dingtalk.com/document/orgapp/query-user-details)接口获取。 */
+  operatorUnionId: string
+  /** 需要查询的设备ID，该参数可从订阅[设备绑定会议室变更](https://open.dingtalk.com/document/orgapp/device-binding-meeting-room-change-event)事件中获取。 */
+  deviceId?: string
+  /** 需要查询的设备unionId，该参数可从订阅[设备绑定会议室变更](https://open.dingtalk.com/document/orgapp/device-binding-meeting-room-change-event)事件中获取。 */
+  deviceUnionId?: string
+}
+
+export interface QueryDevicePropertiesResponse {
+  result?: {
+    propertyName?: string
+    propertyValue?: string
+  }[]
+}
+
+export interface QueryMeetingRoomDeviceQuery {
+  /** 操作查询的人员unionId，可调用[查询用户详情](https://open.dingtalk.com/document/orgapp/query-user-details)接口获取。 */
+  operatorUnionId: string
+  /** 需要查询的设备ID，该参数从订阅[设备绑定会议室变更](https://open.dingtalk.com/document/orgapp/device-binding-meeting-room-change-event)事件中获取。 */
+  deviceId?: string
+  /** 需要查询的设备unionId，该参数从订阅[设备绑定会议室变更](https://open.dingtalk.com/document/orgapp/device-binding-meeting-room-change-event)事件中获取。 */
+  deviceUnionId?: string
+}
+
+export interface QueryMeetingRoomDeviceResponse {
+  result?: {
+    deviceId?: string
+    deviceUnionId?: string
+    openRoomId?: string
+    corpId?: string
+    deviceName?: string
+    shareCode?: string
+    deviceSn?: string
+    deviceMac?: string
+    deviceType?: string
+    deviceServiceId?: number
+    deviceModel?: string
+    deviceStatus?: string
+    controllers?: number
+  }
+}
+
+export interface DeleteMeetingRoomGroupQuery {
+  /** 操作人的unionId。 */
+  unionId: string
+}
+
+export interface DeleteMeetingRoomGroupResponse {
+  result?: unknown
+}
+
+export interface UpdateMeetingRoomGroupParams {
+  /** 操作人的unionId。 */
+  unionId: string
+  /** 修改后的分组名称。 */
+  groupName?: string
+  /** 分组ID。 */
+  groupId: number
+}
+
+export interface UpdateMeetingRoomGroupResponse {
+  result?: unknown
+}
+
+export interface QueryMeetingRoomGroupListQuery {
+  /** 操作人的unionId。 */
+  unionId: string
+}
+
+export interface QueryMeetingRoomGroupListResponse {
+  result?: {
+    groupId?: number
+    groupName?: string
+    parentId?: number
+  }[]
+}
+
+export interface QueryMeetingRoomGroupQuery {
+  /** 操作人的unionId。 */
+  unionId: string
+}
+
+export interface QueryMeetingRoomGroupResponse {
+  groupId?: number
+  groupName?: string
+  parentId?: number
+}
+
+export interface CreateMeetingRoomGroupParams {
+  /** 操作人的unionId。 */
+  unionId: string
+  /** 分组名称。 */
+  groupName?: string
+  /** 父分组ID，传0表示根分组。 */
+  parentGroupId: number
+}
+
+export interface CreateMeetingRoomGroupResponse {
+  result?: number
+}
+
+export interface DeleteMeetingRoomQuery {
+  /** 操作人的unionId。 */
+  unionId: string
+}
+
+export interface DeleteMeetingRoomResponse {
+  result?: unknown
+}
+
+export interface QueryMeetingRoomListQuery {
+  /** 分页游标。 */
+  nextToken?: number
+  /** 请求分页大小，默认值20，目前未限制最大值。 */
+  maxResults?: number
+  /** 操作人的unionId。 */
+  unionId: string
+}
+
+export interface QueryMeetingRoomListResponse {
+  hasMore?: unknown
+  nextToken?: number
+  result?: {
+    roomId?: string
+    roomStaffId?: string
+    corpId?: string
+    roomName?: string
+    roomStatus?: number
+    roomLabels?: number
+    roomCapacity?: number
+    roomLocation?: number
+    roomPicture?: string
+    isvRoomId?: string
+    roomGroup?: number
+  }[]
+}
+
+export interface UpdateMeetingRoomParams {
+  /** 操作人的unionId。 */
+  unionId: string
+  /** 会议室ID。 */
+  roomId: string
+  /** 会议室名称。 */
+  roomName?: string
+  /** 会议室可容纳人数。 */
+  roomCapacity?: number
+  /** 会议室图片。 */
+  roomPicture?: string
+  /** 会议室状态。 */
+  roomStatus?: number
+  /** 会议室位置信息。 */
+  roomLocation?: unknown
+  /** 标签ID。 */
+  roomLabelIds?: number[]
+  /** 调用方外部会议室ID，调用方可传入自有系统内的会议室ID。 */
+  isvRoomId?: string
+  /** 会议室所属分组ID。 */
+  groupId?: number
+}
+
+export interface UpdateMeetingRoomResponse {
+  result?: unknown
+}
+
+export interface QueryMeetingRoomQuery {
+  /** 操作人的unionId。 */
+  unionId: string
+}
+
+export interface QueryMeetingRoomResponse {
+  result?: {
+    roomId?: string
+    roomStaffId?: string
+    corpId?: string
+    roomName?: string
+    roomStatus?: number
+    roomLabels?: number
+    roomCapacity?: number
+    roomLocation?: number
+    roomPicture?: string
+    isvRoomId?: string
+    roomGroup?: number
+  }
+}
+
+export interface CreateMeetingRoomParams {
+  /** 操作人的unionId。 */
+  unionId: string
+  /** 会议室名称。 */
+  roomName: string
+  /** 会议室可容纳人数，目前无最大值限制。 */
+  roomCapacity?: number
+  /** 会议室图片。 */
+  roomPicture?: string
+  /** 会议室状态。 */
+  roomStatus: number
+  /** 会议室位置信息。 */
+  roomLocation?: unknown
+  /** 标签ID。 */
+  roomLabelIds?: number[]
+  /** 调用方外部会议室ID，调用方可传入自有系统内的会议室ID。 */
+  isvRoomId: string
+  /** 分组ID。 */
+  groupId?: number
+}
+
+export interface CreateMeetingRoomResponse {
+  result?: string
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/rooms/devices/properties/query': { POST: { queryDeviceProperties: false } },
+  '/rooms/devices': { GET: { queryMeetingRoomDevice: false } },
+  '/rooms/groups/{groupId}': {
+    DELETE: { deleteMeetingRoomGroup: false },
+    GET: { queryMeetingRoomGroup: false },
+  },
+  '/rooms/groups': {
+    PUT: { updateMeetingRoomGroup: false },
+    POST: { createMeetingRoomGroup: false },
+  },
+  '/rooms/groupLists': { GET: { queryMeetingRoomGroupList: false } },
+  '/rooms/meetingRooms/{roomId}': {
+    DELETE: { deleteMeetingRoom: false },
+    GET: { queryMeetingRoom: false },
+  },
+  '/rooms/meetingRoomLists': { GET: { queryMeetingRoomList: false } },
+  '/rooms/meetingRooms': { PUT: { updateMeetingRoom: false } },
+  '/rooms/meetingrooms': { POST: { createMeetingRoom: false } },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 查询设备属性
+     * @see https://open.dingtalk.com/document/app/querying-video-conference-device-attribute-information
+     */
+    queryDeviceProperties(
+      query: QueryDevicePropertiesQuery,
+      params: QueryDevicePropertiesParams,
+    ): Promise<QueryDevicePropertiesResponse>
+    /**
+     * 查询设备信息
+     * @see https://open.dingtalk.com/document/app/querying-video-conference-device-information
+     */
+    queryMeetingRoomDevice(
+      query: QueryMeetingRoomDeviceQuery,
+    ): Promise<QueryMeetingRoomDeviceResponse>
+    /**
+     * 删除会议室分组
+     * @see https://open.dingtalk.com/document/isvapp/delete-a-conference-room-group
+     */
+    deleteMeetingRoomGroup(
+      groupId: number,
+      query: DeleteMeetingRoomGroupQuery,
+    ): Promise<DeleteMeetingRoomGroupResponse>
+    /**
+     * 更新会议室分组信息
+     * @see https://open.dingtalk.com/document/isvapp/update-meeting-room-group-information
+     */
+    updateMeetingRoomGroup(
+      params: UpdateMeetingRoomGroupParams,
+    ): Promise<UpdateMeetingRoomGroupResponse>
+    /**
+     * 查询会议室分组列表
+     * @see https://open.dingtalk.com/document/isvapp/query-meeting-room-groups
+     */
+    queryMeetingRoomGroupList(
+      query: QueryMeetingRoomGroupListQuery,
+    ): Promise<QueryMeetingRoomGroupListResponse>
+    /**
+     * 查询会议室分组信息
+     * @see https://open.dingtalk.com/document/isvapp/query-meeting-room-group-information
+     */
+    queryMeetingRoomGroup(
+      groupId: number,
+      query: QueryMeetingRoomGroupQuery,
+    ): Promise<QueryMeetingRoomGroupResponse>
+    /**
+     * 创建会议室分组
+     * @see https://open.dingtalk.com/document/isvapp/create-a-meeting-room-group
+     */
+    createMeetingRoomGroup(
+      params: CreateMeetingRoomGroupParams,
+    ): Promise<CreateMeetingRoomGroupResponse>
+    /**
+     * 删除会议室
+     * @see https://open.dingtalk.com/document/isvapp/delete-a-meeting-room
+     */
+    deleteMeetingRoom(
+      roomId: string,
+      query: DeleteMeetingRoomQuery,
+    ): Promise<DeleteMeetingRoomResponse>
+    /**
+     * 查询会议室列表
+     * @see https://open.dingtalk.com/document/isvapp/check-the-meeting-room-list
+     */
+    queryMeetingRoomList(
+      query: QueryMeetingRoomListQuery,
+    ): Promise<QueryMeetingRoomListResponse>
+    /**
+     * 更新会议室信息
+     * @see https://open.dingtalk.com/document/isvapp/update-meeting-room-information
+     */
+    updateMeetingRoom(
+      params: UpdateMeetingRoomParams,
+    ): Promise<UpdateMeetingRoomResponse>
+    /**
+     * 查询会议室详情
+     * @see https://open.dingtalk.com/document/isvapp/check-meeting-room-details
+     */
+    queryMeetingRoom(
+      roomId: string,
+      query: QueryMeetingRoomQuery,
+    ): Promise<QueryMeetingRoomResponse>
+    /**
+     * 创建智能会议室
+     * @see https://open.dingtalk.com/document/isvapp/create-a-meeting-room
+     */
+    createMeetingRoom(
+      params: CreateMeetingRoomParams,
+    ): Promise<CreateMeetingRoomResponse>
+  }
+}

package/src/api/serviceGroup.ts

@@ -0,0 +1,216 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface AddMemberToServiceGroupParams {
+  /** 开放团队ID。如下图所示，查看**ID信息**内的**团队ID**值。 */
+  openTeamId: string
+  /** 服务群openConversionId，调用[创建场景服务群](https://open.dingtalk.com/document/orgapp-server/create-a-scenario-service-group)接口获取openConversationId参数值。 */
+  openConversationId: string
+  /** 待添加员工在钉钉组织内的的userId列表，最大值100。 */
+  userIds: string[]
+}
+
+export interface AddMemberToServiceGroupResponse {
+  success?: unknown
+}
+
+export interface SendMsgByTaskParams {
+  /** 团队ID。 */
+  openTeamId: string
+  /** 群发任务名称。 */
+  taskName: string
+  /** 群发内容。 */
+  messageContent: unknown
+  /** 查询条件。 */
+  queryGroup: unknown
+  /** 发送配置。 */
+  sendConfig: unknown
+}
+
+export interface SendMsgByTaskResponse {
+  openBatchTaskId?: string
+}
+
+export interface UpgradeNormalGroupParams {
+  /** 升级的目标群组ID。 */
+  openGroupSetId?: string
+  /** 升级的目标群模板ID。 */
+  templateId?: string
+  /** 群ID。 */
+  openConversationId: string
+  /** 升级的目标团队ID。 */
+  openTeamId?: string
+}
+
+export interface UpgradeCloudGroupParams {
+  /** 群ID。 */
+  openConversationId: string
+  /** 升级的目标群模板ID。 */
+  templateId?: string
+  /** 升级的目标群组ID。 */
+  openGroupSetId?: string
+  /** 智能云客服租户ID。 */
+  ccsInstanceId: string
+  /** 升级的目标团队ID。 */
+  openTeamId?: string
+}
+
+export interface QueryActiveUsersQuery {
+  /** 开放团队ID。 */
+  openTeamId?: string
+  /** 群ID。 */
+  openConversationId: string
+  /** 活跃度排名topN，如top5，最多支持top100 */
+  topN?: number
+}
+
+export interface QueryActiveUsersResponse {
+  activeUserInfos: {
+    unionId: string
+    nickName: string
+    actionIndexL7d: number
+    actionIndexL14d: number
+    actionIndexL30d: number
+    activeScore: number
+    ranking: number
+  }[]
+}
+
+export interface SendServiceGroupMessageParams {
+  /** 开放群ID。 */
+  targetOpenConversationId: string
+  /** 标题。 */
+  title: string
+  /** 消息内容。 */
+  content: string
+  /** 是否 at所有人 */
+  isAtAll?: unknown
+  /** 被@人的手机号列表。 */
+  atMobiles?: string[]
+  /** 被@人的dingtalkId列表。 */
+  atDingtalkIds?: string[]
+  /** 被@人的unionId列表。 */
+  atUnionIds?: string[]
+  /** 手机号接收者列表。 */
+  receiverMobiles?: string[]
+  /** dingtalkId接收者列表。 */
+  receiverDingtalkIds?: string[]
+  /** unionId接收者列表。 */
+  receiverUnionIds?: string[]
+  /** 消息类型，取值。 */
+  messageType: string
+  /** 排列方式。 */
+  btnOrientation?: string
+  /** actionCard按钮。 */
+  btns?: object[]
+  /** 消息内容是否含有链接。 */
+  hasContentLinks?: unknown
+}
+
+export interface SendServiceGroupMessageResponse {
+  openMsgTaskId: string
+}
+
+export interface ServiceGroupCreateGroupParams {
+  /** 业务关联ID，自定义参数值。 */
+  groupBizId?: string
+  /** 开放团队ID。 */
+  openTeamId: string
+  /** 开放群组ID。 */
+  openGroupSetId: string
+  /** 群名称。 */
+  groupName: string
+  /** 群主员工userid。 */
+  ownerStaffId: string
+  /** 群成员员工ID列表，最大值20。 */
+  memberStaffIds?: string[]
+  /** 群标签。 */
+  groupTagNames?: string[]
+}
+
+export interface ServiceGroupCreateGroupResponse {
+  openConversationId: string
+  groupUrl: string
+}
+
+export interface ServiceGroupUpdateGroupSetParams {
+  /** 开放团队ID。 */
+  openTeamId?: string
+  /** 开放群ID，可调用[创建服务群](https://open.dingtalk.com/document/orgapp-server/create-a-scenario-service-group)接口获取openConversationId参数值。 */
+  openConversationId?: string
+  /** 开放群组ID。 */
+  openGroupSetId?: string
+}
+
+export interface ServiceGroupUpdateGroupSetResponse {
+  success?: unknown
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/serviceGroup/groups/members': { POST: { addMemberToServiceGroup: false } },
+  '/serviceGroup/messages/tasks/send': { POST: { sendMsgByTask: false } },
+  '/serviceGroup/normalGroups/upgrade': { POST: { upgradeNormalGroup: false } },
+  '/serviceGroup/cloudGroups/upgrade': { POST: { upgradeCloudGroup: false } },
+  '/serviceGroup/groups/queryActiveUsers': { GET: { queryActiveUsers: false } },
+  '/serviceGroup/messages/send': { POST: { sendServiceGroupMessage: false } },
+  '/serviceGroup/groups': { POST: { serviceGroupCreateGroup: false } },
+  '/serviceGroup/groups/configurations': {
+    PUT: { serviceGroupUpdateGroupSet: false },
+  },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 添加服务群成员
+     * @see https://open.dingtalk.com/document/orgapp/add-service-group-members
+     */
+    addMemberToServiceGroup(
+      params: AddMemberToServiceGroupParams,
+    ): Promise<AddMemberToServiceGroupResponse>
+    /**
+     * 服务群发任务
+     * @see https://open.dingtalk.com/document/orgapp/service-group-sending-task-interface
+     */
+    sendMsgByTask(params: SendMsgByTaskParams): Promise<SendMsgByTaskResponse>
+    /**
+     * 升级普通群为服务群
+     * @see https://open.dingtalk.com/document/orgapp/a-dingtalk-group-is-upgraded-to-one-of-the-intelligent
+     */
+    upgradeNormalGroup(params: UpgradeNormalGroupParams): Promise<void>
+    /**
+     * 升级云客服服务群为钉钉智能服务群
+     * @see https://open.dingtalk.com/document/orgapp/upgraded-the-cloud-customer-service-group-to-the-dingtalk-intelligent
+     */
+    upgradeCloudGroup(params: UpgradeCloudGroupParams): Promise<void>
+    /**
+     * 查询服务群活跃成员
+     * @see https://open.dingtalk.com/document/orgapp/queries-active-service-users
+     */
+    queryActiveUsers(
+      query: QueryActiveUsersQuery,
+    ): Promise<QueryActiveUsersResponse>
+    /**
+     * 服务群发消息
+     * @see https://open.dingtalk.com/document/orgapp/service-group-message-sending-interface
+     */
+    sendServiceGroupMessage(
+      params: SendServiceGroupMessageParams,
+    ): Promise<SendServiceGroupMessageResponse>
+    /**
+     * 创建服务群
+     * @see https://open.dingtalk.com/document/orgapp/create-a-scenario-service-group
+     */
+    serviceGroupCreateGroup(
+      params: ServiceGroupCreateGroupParams,
+    ): Promise<ServiceGroupCreateGroupResponse>
+    /**
+     * 更换服务群所在的群分组
+     * @see https://open.dingtalk.com/document/isvapp/modify-a-service-group
+     */
+    serviceGroupUpdateGroupSet(
+      params: ServiceGroupUpdateGroupSetParams,
+    ): Promise<ServiceGroupUpdateGroupSetResponse>
+  }
+}