@satorijs/adapter-dingtalk 1.0.0

package/lib/api/resident.d.ts

@@ -0,0 +1,106 @@
+export interface AddPointQuery {
+    /** 是否查询全员圈积分规则，取值： */
+    isCircle: unknown;
+    /** 加减积分的唯一幂等标志，由调用方自己生成。 */
+    uuid: string;
+    /** 用户userid，可以调用[通过免登码获取用户信息](https://developers.dingtalk.com/document/app/obtain-the-userid-of-a-user-by-using-the-log-free)接口获取。 */
+    userId: string;
+    /** 规则代码。可以为空。 */
+    ruleCode?: string;
+    /** 规则名字。 */
+    ruleName: string;
+    /** 增加积分的时间戳，单位毫秒。 */
+    actionTime?: number;
+    /** 本次增加积分。 */
+    score: number;
+}
+export interface PagePointHistoryQuery {
+    /** 是否查询全员圈积分记录，否则查询积分管理积分记录，取值： */
+    isCircle: unknown;
+    /** 用户userid。 */
+    userId?: string;
+    /** 分页游标，第一次请求传0，后续取值是上一次调用此API返回的nextToken参数。 */
+    nextToken: number;
+    /** 本次读取的最大数据记录数量，最大值20。 */
+    maxResults: number;
+    /** 起始时间Unix时间戳，单位毫秒。 */
+    startTime?: number;
+    /** 结束时间Unix时间戳（不包含），单位毫秒。 */
+    endTime?: number;
+}
+export interface PagePointHistoryResponse {
+    pointRecordList: {
+        userId: string;
+        score: number;
+        createAt: number;
+        uuid: string;
+        ruleCode?: string;
+        ruleName: string;
+    }[];
+    hasMore: unknown;
+    nextToken: number;
+    totalCount: number;
+}
+export interface ListPointRulesQuery {
+    /** 是否查询全员圈积分规则，否则查询积分管理积分规则，取值： */
+    isCircle: unknown;
+}
+export interface ListPointRulesResponse {
+    pointRuleList: {
+        score: number;
+        dayLimitTimes: number;
+        status: number;
+        ruleCode?: string;
+        ruleName: string;
+        extension: string;
+        groupId: number;
+        orderId: number;
+    }[];
+}
+export interface ListIndustryRoleUsersQuery {
+    /** 行业角色编码，有以下取值： */
+    tagCode: string;
+}
+export interface ListIndustryRoleUsersResponse {
+    userIdList?: string[];
+}
+export interface ListUserIndustryRolesQuery {
+    /** 用户userId。 */
+    userId: string;
+}
+export interface ListUserIndustryRolesResponse {
+    roleList?: {
+        roleId?: number;
+        roleName?: string;
+        tagCode?: string;
+    }[];
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 增加或减少居民积分
+         * @see https://developers.dingtalk.com/document/isvapp/increase-or-decrease-resident-points
+         */
+        addPoint(query: AddPointQuery): Promise<void>;
+        /**
+         * 查询数字区县居民积分流水
+         * @see https://developers.dingtalk.com/document/isvapp/query-the-integral-flow-records-by-page
+         */
+        pagePointHistory(query: PagePointHistoryQuery): Promise<PagePointHistoryResponse>;
+        /**
+         * 查询组织维度配置的的积分规则
+         * @see https://developers.dingtalk.com/document/isvapp/query-all-credit-rules
+         */
+        listPointRules(query: ListPointRulesQuery): Promise<ListPointRulesResponse>;
+        /**
+         * 获取行业角色下的用户列表
+         * @see https://developers.dingtalk.com/document/isvapp/obtains-a-list-of-users-under-an-industry-role
+         */
+        listIndustryRoleUsers(query: ListIndustryRoleUsersQuery): Promise<ListIndustryRoleUsersResponse>;
+        /**
+         * 获取用户所在的行业角色信息
+         * @see https://developers.dingtalk.com/document/isvapp/obtains-information-about-the-industry-role-to-which-the-user
+         */
+        listUserIndustryRoles(query: ListUserIndustryRolesQuery): Promise<ListUserIndustryRolesResponse>;
+    }
+}

package/lib/api/robot.d.ts

@@ -0,0 +1,255 @@
+export interface GetBotListInGroupParams {
+    /** 群ID： */
+    openConversationId: string;
+}
+export interface GetBotListInGroupResponse {
+    chatbotInstanceVOList?: {
+        robotCode?: string;
+        name?: string;
+        downloadIconURL?: string;
+        openRobotType?: number;
+    }[];
+}
+export interface RobotMessageFileDownloadParams {
+    /** 用户向机器人发送文件消息后，机器人回调给开发者消息中的下载码。 */
+    downloadCode: string;
+    /** 机器人的编码： */
+    robotCode: string;
+}
+export interface RobotMessageFileDownloadResponse {
+    downloadUrl: string;
+}
+export interface ClearRobotPluginParams {
+    /** 机器人的编码，参见[机器人名词表-robotCode](https://open.dingtalk.com/document/orgapp/robot-overview#title-ed9-e7b-epe)内容，获取`robotCode`。 */
+    robotCode: string;
+}
+export interface ClearRobotPluginResponse {
+    result?: unknown;
+}
+export interface SetRobotPluginParams {
+    /** 机器人的编码，参见[机器人名词表-robotCode](https://open.dingtalk.com/document/orgapp/robot-overview#title-ed9-e7b-epe)内容，获取`robotCode`。 */
+    robotCode?: string;
+    /** 插件信息。 */
+    pluginInfoList?: object[];
+}
+export interface SetRobotPluginResponse {
+    result?: unknown;
+}
+export interface QueryRobotPluginParams {
+    /** 机器人的编码，参见[机器人名词表-robotCode](https://open.dingtalk.com/document/orgapp/robot-overview#title-ed9-e7b-epe)内容，获取`robotCode`。 */
+    robotCode: string;
+}
+export interface QueryRobotPluginResponse {
+    pluginInfoList?: {
+        name?: string;
+        icon?: string;
+        pcUrl?: string;
+        mobileUrl?: string;
+    }[];
+}
+export interface OrgGroupRecallParams {
+    /** 开放的群ID。 */
+    openConversationId: string;
+    /** 机器人的编码。 */
+    robotCode: string;
+    processQueryKeys: string[];
+}
+export interface OrgGroupRecallResponse {
+    successResult: string[];
+    failedResult: unknown;
+}
+export interface OrgGroupQueryParams {
+    /** 开放的群id。 */
+    openConversationId?: string;
+    /** 机器人的robotCode。 */
+    robotCode?: string;
+    /** 机器人在群内安装后，群内机器人的webhook属性中中的access_token部分的值。 */
+    token?: string;
+    /** 发送消息返回的加密消息id。 */
+    processQueryKey: string;
+    /** 分页查询每页的数量。 */
+    maxResults?: number;
+    /** 一次查询后返回的加密的分页凭证，首次查询不填。 */
+    nextToken?: string;
+}
+export interface OrgGroupQueryResponse {
+    sendStatus?: string;
+    readUserIds?: string[];
+    nextToken?: string;
+    hasMore?: unknown;
+}
+export interface OrgGroupSendParams {
+    /** 消息模板参数。 */
+    msgParam: string;
+    /** 消息模板key。 */
+    msgKey: string;
+    /** 群id： */
+    openConversationId?: string;
+    /** 机器人的编码。 */
+    robotCode?: string;
+    /** 机器人在群内安装后，群内机器人的webhook属性中中的`access_token`的参数值。 */
+    token?: string;
+    /** 群聊酷应用编码。 */
+    coolAppCode?: string;
+}
+export interface OrgGroupSendResponse {
+    processQueryKey: string;
+}
+export interface BatchRecallOTOParams {
+    /** 机器人的编码。 */
+    robotCode: string;
+    processQueryKeys: string[];
+}
+export interface BatchRecallOTOResponse {
+    successResult?: string[];
+    failedResult?: unknown;
+}
+export interface BatchOTOQueryQuery {
+    /** - 企业内部开发-机器人，此处为企业自建应用的appKey。 */
+    robotCode: string;
+    /** 加密的消息id，可通过调用[发送批量单聊信息](https://open.dingtalk.com/document/group/chatbots-send-one-on-one-chat-messages-in-batches)接口获取。 */
+    processQueryKey: string;
+}
+export interface BatchOTOQueryResponse {
+    sendStatus?: string;
+    messageReadInfoList?: {
+        name: string;
+        userId: string;
+        readStatus: string;
+        readTimestamp: number;
+    }[];
+}
+export interface BatchSendOTOParams {
+    /** 机器人的编码。 */
+    robotCode: string;
+    /** 用户的userid。 */
+    userIds: string[];
+    /** 消息的msgKey。 */
+    msgKey: string;
+    /** 消息体。 */
+    msgParam: string;
+}
+export interface BatchSendOTOResponse {
+    processQueryKey?: string;
+    invalidStaffIdList?: string[];
+    flowControlledStaffIdList?: string[];
+}
+export interface PrivateChatSendParams {
+    /** 消息体。 */
+    msgParam: string;
+    /** 消息类型的key。 */
+    msgKey: string;
+    /** 会话ID。 */
+    openConversationId?: string;
+    /** 机器人编码。 */
+    robotCode?: string;
+    /** 酷应用的code。 */
+    coolAppCode?: string;
+}
+export interface PrivateChatSendResponse {
+    processQueryKey: string;
+}
+export interface PrivateChatQueryParams {
+    /** 人与人单聊开放会话ID： */
+    openConversationId?: string;
+    /** 机器人的编码，参见[机器人名词表-robotCode](https://open.dingtalk.com/document/group/robot-overview)内容，获取`robotCode`。 */
+    robotCode?: string;
+    /** 发送消息返回的加密消息id */
+    processQueryKey: string;
+    /** 分页查询每页的数量 */
+    maxResults?: number;
+    /** 一次查询后返回的加密的分页凭证，首次查询不填 */
+    nextToken?: string;
+}
+export interface PrivateChatQueryResponse {
+    sendStatus?: string;
+    readUserIds?: string[];
+    nextToken?: string;
+    hasMore?: unknown;
+}
+export interface BatchRecallPrivateChatParams {
+    /** 人与人单聊开放会话ID： */
+    openConversationId: string;
+    /** 机器人的编码，参见[机器人名词表-robotCode](https://open.dingtalk.com/document/group/robot-overview)内容，获取`robotCode`。 */
+    robotCode: string;
+    /** 消息id */
+    processQueryKeys: string[];
+}
+export interface BatchRecallPrivateChatResponse {
+    successResult: string[];
+    failedResult: unknown;
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 查询群内的机器人列表
+         * @see https://developers.dingtalk.com/document/orgapp/obtain-the-list-of-robots-in-the-group
+         */
+        getBotListInGroup(params: GetBotListInGroupParams): Promise<GetBotListInGroupResponse>;
+        /**
+         * 获取机器人消息中文件下载链接
+         * @see https://developers.dingtalk.com/document/isvapp/download-the-file-content-of-the-robot-receiving-message
+         */
+        robotMessageFileDownload(params: RobotMessageFileDownloadParams): Promise<RobotMessageFileDownloadResponse>;
+        /**
+         * 清空单聊机器人快捷入口
+         * @see https://developers.dingtalk.com/document/orgapp/clear-single-chat-robot-quick-entry
+         */
+        clearRobotPlugin(params: ClearRobotPluginParams): Promise<ClearRobotPluginResponse>;
+        /**
+         * 设置单聊机器人快捷入口
+         * @see https://developers.dingtalk.com/document/orgapp/set-robot-quick-entrance
+         */
+        setRobotPlugin(params: SetRobotPluginParams): Promise<SetRobotPluginResponse>;
+        /**
+         * 查询单聊机器人快捷入口
+         * @see https://developers.dingtalk.com/document/orgapp/quick-entrance-of-inquiry-single-chat-robot
+         */
+        queryRobotPlugin(params: QueryRobotPluginParams): Promise<QueryRobotPluginResponse>;
+        /**
+         * 企业机器人撤回内部群消息
+         * @see https://developers.dingtalk.com/document/orgapp/enterprise-chatbot-withdraws-internal-group-messages
+         */
+        orgGroupRecall(params: OrgGroupRecallParams): Promise<OrgGroupRecallResponse>;
+        /**
+         * 查询企业机器人群聊消息用户已读状态
+         * @see https://developers.dingtalk.com/document/orgapp/chatbot-queries-the-read-status-of-a-message
+         */
+        orgGroupQuery(params: OrgGroupQueryParams): Promise<OrgGroupQueryResponse>;
+        /**
+         * 机器人发送群聊消息
+         * @see https://developers.dingtalk.com/document/orgapp/the-robot-sends-a-group-message
+         */
+        orgGroupSend(params: OrgGroupSendParams): Promise<OrgGroupSendResponse>;
+        /**
+         * 批量撤回人与机器人会话中机器人消息
+         * @see https://developers.dingtalk.com/document/orgapp/batch-message-recall-chat
+         */
+        batchRecallOTO(params: BatchRecallOTOParams): Promise<BatchRecallOTOResponse>;
+        /**
+         * 批量查询人与机器人会话机器人消息是否已读
+         * @see https://developers.dingtalk.com/document/orgapp/chatbot-batch-query-the-read-status-of-messages
+         */
+        batchOTOQuery(query: BatchOTOQueryQuery): Promise<BatchOTOQueryResponse>;
+        /**
+         * 批量发送人与机器人会话中机器人消息
+         * @see https://developers.dingtalk.com/document/orgapp/chatbots-send-one-on-one-chat-messages-in-batches
+         */
+        batchSendOTO(params: BatchSendOTOParams): Promise<BatchSendOTOResponse>;
+        /**
+         * 人与人会话中机器人发送普通消息
+         * @see https://developers.dingtalk.com/document/orgapp/the-robot-sends-ordinary-messages-in-a-person-to-person-conversation
+         */
+        privateChatSend(params: PrivateChatSendParams): Promise<PrivateChatSendResponse>;
+        /**
+         * 查询人与人会话中机器人已读消息
+         * @see https://developers.dingtalk.com/document/orgapp/query-the-read-list-of-robot-messages-in-person-to-person-conversations
+         */
+        privateChatQuery(params: PrivateChatQueryParams): Promise<PrivateChatQueryResponse>;
+        /**
+         * 批量撤回人与人会话中机器人消息
+         * @see https://developers.dingtalk.com/document/orgapp/batch-withdrawal-of-single-chat-robot-messages-in-person-to-person-conversations
+         */
+        batchRecallPrivateChat(params: BatchRecallPrivateChatParams): Promise<BatchRecallPrivateChatResponse>;
+    }
+}

package/lib/api/rooms.d.ts

@@ -0,0 +1,255 @@
+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;
+}
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 查询设备属性
+         * @see https://developers.dingtalk.com/document/app/querying-video-conference-device-attribute-information
+         */
+        queryDeviceProperties(query: QueryDevicePropertiesQuery, params: QueryDevicePropertiesParams): Promise<QueryDevicePropertiesResponse>;
+        /**
+         * 查询设备信息
+         * @see https://developers.dingtalk.com/document/app/querying-video-conference-device-information
+         */
+        queryMeetingRoomDevice(query: QueryMeetingRoomDeviceQuery): Promise<QueryMeetingRoomDeviceResponse>;
+        /**
+         * 删除会议室分组
+         * @see https://developers.dingtalk.com/document/isvapp/delete-a-conference-room-group
+         */
+        deleteMeetingRoomGroup(groupId: number, query: DeleteMeetingRoomGroupQuery): Promise<DeleteMeetingRoomGroupResponse>;
+        /**
+         * 更新会议室分组信息
+         * @see https://developers.dingtalk.com/document/isvapp/update-meeting-room-group-information
+         */
+        updateMeetingRoomGroup(params: UpdateMeetingRoomGroupParams): Promise<UpdateMeetingRoomGroupResponse>;
+        /**
+         * 查询会议室分组列表
+         * @see https://developers.dingtalk.com/document/isvapp/query-meeting-room-groups
+         */
+        queryMeetingRoomGroupList(query: QueryMeetingRoomGroupListQuery): Promise<QueryMeetingRoomGroupListResponse>;
+        /**
+         * 查询会议室分组信息
+         * @see https://developers.dingtalk.com/document/isvapp/query-meeting-room-group-information
+         */
+        queryMeetingRoomGroup(groupId: number, query: QueryMeetingRoomGroupQuery): Promise<QueryMeetingRoomGroupResponse>;
+        /**
+         * 创建会议室分组
+         * @see https://developers.dingtalk.com/document/isvapp/create-a-meeting-room-group
+         */
+        createMeetingRoomGroup(params: CreateMeetingRoomGroupParams): Promise<CreateMeetingRoomGroupResponse>;
+        /**
+         * 删除会议室
+         * @see https://developers.dingtalk.com/document/isvapp/delete-a-meeting-room
+         */
+        deleteMeetingRoom(roomId: string, query: DeleteMeetingRoomQuery): Promise<DeleteMeetingRoomResponse>;
+        /**
+         * 查询会议室列表
+         * @see https://developers.dingtalk.com/document/isvapp/check-the-meeting-room-list
+         */
+        queryMeetingRoomList(query: QueryMeetingRoomListQuery): Promise<QueryMeetingRoomListResponse>;
+        /**
+         * 更新会议室信息
+         * @see https://developers.dingtalk.com/document/isvapp/update-meeting-room-information
+         */
+        updateMeetingRoom(params: UpdateMeetingRoomParams): Promise<UpdateMeetingRoomResponse>;
+        /**
+         * 查询会议室详情
+         * @see https://developers.dingtalk.com/document/isvapp/check-meeting-room-details
+         */
+        queryMeetingRoom(roomId: string, query: QueryMeetingRoomQuery): Promise<QueryMeetingRoomResponse>;
+        /**
+         * 创建智能会议室
+         * @see https://developers.dingtalk.com/document/isvapp/create-a-meeting-room
+         */
+        createMeetingRoom(params: CreateMeetingRoomParams): Promise<CreateMeetingRoomResponse>;
+    }
+}