@satorijs/adapter-dingtalk 2.0.3 → 2.0.5

package/src/api/swform.ts

@@ -0,0 +1,94 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface GetFormInstanceQuery {
+  /** 填表类型。 */
+  bizType?: number
+}
+
+export interface GetFormInstanceResponse {
+  success?: unknown
+  result?: {
+    createTime?: string
+    modifyTime?: string
+    formCode?: string
+    title?: string
+    creator?: string
+    forms?: number
+  }
+}
+
+export interface ListFormInstancesQuery {
+  /** 填表类型。 */
+  bizType?: number
+  /** 时间，格式要求为yyyy-MM-dd。 */
+  actionDate?: string
+  /** 分页游标。 */
+  nextToken: number
+  /** 每页最大条目数，最大值100。 */
+  maxResults: number
+}
+
+export interface ListFormInstancesResponse {
+  success?: unknown
+  result?: {
+    hasMore?: number
+    nextToken?: number
+    list?: number
+  }
+}
+
+export interface ListFormSchemasByCreatorQuery {
+  /** 每页最大条目数，最大值200。 */
+  maxResults: number
+  /** 填表类型。 */
+  bizType?: number
+  /** 填表创建人userid。 */
+  creator?: string
+  /** 分页游标。 */
+  nextToken: number
+}
+
+export interface ListFormSchemasByCreatorResponse {
+  success?: unknown
+  result?: {
+    hasMore?: number
+    nextToken?: number
+    list?: number
+  }
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/swform/instances/{formInstanceId}': { GET: { getFormInstance: false } },
+  '/swform/forms/{formCode}/instances': { GET: { listFormInstances: false } },
+  '/swform/users/forms': { GET: { listFormSchemasByCreator: false } },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 获取单条填表实例详情
+     * @see https://open.dingtalk.com/document/isvapp/obtains-the-instance-details-of-a-single-fill-table
+     */
+    getFormInstance(
+      formInstanceId: string,
+      query: GetFormInstanceQuery,
+    ): Promise<GetFormInstanceResponse>
+    /**
+     * 获取填表实例列表
+     * @see https://open.dingtalk.com/document/isvapp/obtain-the-table-filling-instance-list-data
+     */
+    listFormInstances(
+      formCode: string,
+      query: ListFormInstancesQuery,
+    ): Promise<ListFormInstancesResponse>
+    /**
+     * 获取用户创建的填表模板列表
+     * @see https://open.dingtalk.com/document/isvapp/new-obtains-the-template-that-a-user-creates
+     */
+    listFormSchemasByCreator(
+      query: ListFormSchemasByCreatorQuery,
+    ): Promise<ListFormSchemasByCreatorResponse>
+  }
+}

package/src/api/todo.ts

@@ -0,0 +1,220 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface QueryOrgTodoTasksParams {
+  /** 分页游标。 */
+  nextToken?: string
+  /** 待办完成状态。 */
+  isDone?: unknown
+}
+
+export interface QueryOrgTodoTasksResponse {
+  nextToken?: string
+  todoCards?: {
+    taskId?: string
+    subject?: string
+    dueTime?: number
+    detailUrl?: number
+    todoCardView?: number
+    priority?: number
+    createdTime?: number
+    modifiedTime?: number
+    todoStatus?: string
+    creatorId?: string
+    sourceId?: string
+    category?: string
+    bizTag?: string
+    originalSource?: number
+    isDone?: number
+    orgInfo?: number
+  }[]
+  totalCount?: number
+}
+
+export interface UpdateTodoTaskExecutorStatusParams {
+  /** 执行者状态列表，id需传用户的unionId。 */
+  executorStatusList?: object[]
+}
+
+export interface UpdateTodoTaskExecutorStatusQuery {
+  /** 当前操作者的用户的unionId。 */
+  operatorId?: string
+}
+
+export interface UpdateTodoTaskExecutorStatusResponse {
+  result?: unknown
+}
+
+export interface CreateTodoTaskParams {
+  /** 业务系统侧的唯一标识ID，即业务ID。 */
+  sourceId?: string
+  /** 待办标题，最大长度1024。 */
+  subject: string
+  /** 创建者的unionId。 */
+  creatorId?: string
+  /** 待办备注描述，最大长度4096。 */
+  description?: string
+  /** 截止时间，Unix时间戳，单位毫秒。 */
+  dueTime?: number
+  /** 执行者的unionId，最大数量1000。 */
+  executorIds?: string[]
+  /** 参与者的unionId，最大数量1000。 */
+  participantIds?: string[]
+  /** 详情页url跳转地址。 */
+  detailUrl?: unknown
+  /** 待办卡片内容区表单自定义字段列表 */
+  contentFieldList?: object[]
+  /** 生成的待办是否仅展示在执行者的待办列表中。 */
+  isOnlyShowExecutor?: unknown
+  /** 优先级，取值： */
+  priority?: number
+  /** 待办通知配置。 */
+  notifyConfigs?: unknown
+  /** 二级分类。 */
+  bizCategoryId?: string
+  /** 编辑 */
+  actionList?: object[]
+}
+
+export interface CreateTodoTaskQuery {
+  /** 当前操作者用户的unionId。 */
+  operatorId?: string
+}
+
+export interface CreateTodoTaskResponse {
+  id: string
+  subject: string
+  description?: string
+  startTime?: number
+  dueTime?: number
+  finishTime?: number
+  done?: unknown
+  executorIds?: string[]
+  participantIds?: string[]
+  detailUrl?: {
+    pcUrl?: string
+    appUrl?: string
+  }
+  source?: string
+  sourceId?: string
+  createdTime: number
+  modifiedTime?: number
+  creatorId: string
+  modifierId?: string
+  tenantId?: string
+  tenantType?: string
+  bizTag?: string
+  requestId?: string
+  cardTypeId?: string
+  contentFieldList?: {
+    fieldKey?: string
+    fieldValue?: string
+  }[]
+  isOnlyShowExecutor?: unknown
+  priority?: number
+  sourceTitle?: string
+  notifyConfigs?: {
+    singleChat?: string
+    dingNotify?: string
+  }
+}
+
+export interface UpdateTodoTaskParams {
+  /** 待办标题，最大长度1024。 */
+  subject?: string
+  /** 待办描述，最大长度4096。 */
+  description?: string
+  /** 截止时间，Unix时间戳，单位毫秒。 */
+  dueTime?: number
+  /** 完成状态。 */
+  done?: unknown
+  /** 执行者的unionId列表，最大数量1000。 */
+  executorIds?: string[]
+  /** 参与者的unionId列表，最大数量1000。 */
+  participantIds?: string[]
+}
+
+export interface UpdateTodoTaskQuery {
+  /** 当前操作者的unionId。 */
+  operatorId?: string
+}
+
+export interface UpdateTodoTaskResponse {
+  result?: unknown
+}
+
+export interface DeleteTodoTaskQuery {
+  /** 当前操作者的用户的unionId。 */
+  operatorId?: string
+}
+
+export interface DeleteTodoTaskResponse {
+  result?: unknown
+  requestId?: string
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/todo/users/{unionId}/org/tasks/query': {
+    POST: { queryOrgTodoTasks: false },
+  },
+  '/todo/users/{unionId}/tasks/{taskId}/executorStatus': {
+    PUT: { updateTodoTaskExecutorStatus: false },
+  },
+  '/todo/users/{unionId}/tasks': { POST: { createTodoTask: false } },
+  '/todo/users/{unionId}/tasks/{taskId}': {
+    PUT: { updateTodoTask: false },
+    DELETE: { deleteTodoTask: false },
+  },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 查询企业下用户待办列表
+     * @see https://open.dingtalk.com/document/isvapp/query-the-to-do-list-of-enterprise-users
+     */
+    queryOrgTodoTasks(
+      unionId: string,
+      params: QueryOrgTodoTasksParams,
+    ): Promise<QueryOrgTodoTasksResponse>
+    /**
+     * 更新钉钉待办执行者状态
+     * @see https://open.dingtalk.com/document/isvapp/update-dingtalk-to-do-status
+     */
+    updateTodoTaskExecutorStatus(
+      unionId: string,
+      taskId: string,
+      query: UpdateTodoTaskExecutorStatusQuery,
+      params: UpdateTodoTaskExecutorStatusParams,
+    ): Promise<UpdateTodoTaskExecutorStatusResponse>
+    /**
+     * 创建待办
+     * @see https://open.dingtalk.com/document/isvapp/add-dingtalk-to-do-task
+     */
+    createTodoTask(
+      unionId: string,
+      query: CreateTodoTaskQuery,
+      params: CreateTodoTaskParams,
+    ): Promise<CreateTodoTaskResponse>
+    /**
+     * 更新钉钉待办任务
+     * @see https://open.dingtalk.com/document/isvapp/updates-dingtalk-to-do-tasks
+     */
+    updateTodoTask(
+      unionId: string,
+      taskId: string,
+      query: UpdateTodoTaskQuery,
+      params: UpdateTodoTaskParams,
+    ): Promise<UpdateTodoTaskResponse>
+    /**
+     * 删除钉钉待办任务
+     * @see https://open.dingtalk.com/document/isvapp/delete-dingtalk-to-do-tasks
+     */
+    deleteTodoTask(
+      unionId: string,
+      taskId: string,
+      query: DeleteTodoTaskQuery,
+    ): Promise<DeleteTodoTaskResponse>
+  }
+}

package/src/api/wiki.ts

@@ -0,0 +1,231 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface ListNodesQuery {
+  /** 父节点id(父节点dentryUuid)： */
+  parentNodeId: string
+  /** 分页游标, 首次拉取不用传。 */
+  nextToken?: string
+  /** 分页大小，默认值50。 */
+  maxResults?: number
+  /** 是否获取权限信息： */
+  withPermissionRole?: unknown
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface ListNodesResponse {
+  nodes?: {
+    nodeId?: string
+    workspaceId?: string
+    name?: string
+    size?: number
+    type?: string
+    category?: string
+    extension?: string
+    url?: string
+    creatorId?: string
+    modifierId?: string
+    createTime?: string
+    modifiedTime?: string
+    hasChildren?: number
+    statisticalInfo?: number
+    permissionRole?: string
+  }[]
+  nextToken?: string
+}
+
+export interface GetNodeByUrlParams {
+  /** 文档链接 */
+  url: string
+  /** 可选参数 */
+  option?: unknown
+}
+
+export interface GetNodeByUrlQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface GetNodeByUrlResponse {
+  node?: {
+    nodeId?: string
+    workspaceId?: string
+    name?: string
+    size?: number
+    type?: string
+    category?: string
+    extension?: string
+    url?: string
+    creatorId?: string
+    modifierId?: string
+    createTime?: string
+    modifiedTime?: string
+    hasChildren?: number
+    statisticalInfo?: number
+    permissionRole?: string
+  }
+}
+
+export interface GetNodesParams {
+  /** 节点id。 */
+  nodeIds: string[]
+  /** 可选参数。 */
+  option?: unknown
+}
+
+export interface GetNodesQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface GetNodesResponse {
+  nodes?: {
+    nodeId?: string
+    workspaceId?: string
+    name?: string
+    size?: number
+    type?: string
+    category?: string
+    extension?: string
+    url?: string
+    creatorId?: string
+    modifierId?: string
+    createTime?: string
+    modifiedTime?: string
+    hasChildren?: number
+    statisticalInfo?: number
+    permissionRole?: string
+  }[]
+}
+
+export interface GetNodeQuery {
+  /** 是否获取统计信息： */
+  withStatisticalInfo?: unknown
+  /** 是否获取权限信息： */
+  withPermissionRole?: unknown
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface GetNodeResponse {
+  node?: {
+    nodeId?: string
+    workspaceId?: string
+    name?: string
+    size?: number
+    type?: string
+    category?: string
+    extension?: string
+    url?: string
+    creatorId?: string
+    modifierId?: string
+    createTime?: string
+    modifiedTime?: string
+    hasChildren?: number
+    statisticalInfo?: number
+    permissionRole?: string
+  }
+}
+
+export interface WikiWordsDetailQuery {
+  /** 词条名称，最大长度50个字符。 */
+  wordName: string
+}
+
+export interface WikiWordsDetailResponse {
+  data: {
+    wordName: string
+    uuid: number
+    gmtCreate: number
+    gmtModify: number
+    orgName: string
+    wordAlias: number
+    highLightWordAlias: number
+    wordFullName: string
+    relatedDoc: number
+    relatedLink: number
+    creatorName: string
+    updaterName: string
+    approveName: string
+    wordParaphrase: string
+    simpleWordParaphrase: string
+    contacts: number
+    tagsList: number
+    appLink: number
+    imHighLight: number
+    simHighLight: number
+  }[]
+  errMsg: string
+  success: unknown
+}
+
+export interface WikiWordsParseParams {
+  /** 待匹配词条的文本，最大长度4096个字符。 */
+  content: string
+}
+
+export interface WikiWordsParseResponse {
+  success?: unknown
+  errMsg: string
+  data: {
+    startIndex: number
+    endIndex: number
+    wordName: string
+  }[]
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/wiki/nodes': { GET: { listNodes: false } },
+  '/wiki/nodes/queryByUrl': { POST: { getNodeByUrl: false } },
+  '/wiki/nodes/batchQuery': { POST: { getNodes: false } },
+  '/wiki/nodes/{nodeId}': { GET: { getNode: false } },
+  '/wiki/words/details': { GET: { wikiWordsDetail: false } },
+  '/wiki/words/parse': { POST: { wikiWordsParse: false } },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 获取节点列表
+     * @see https://open.dingtalk.com/document/orgapp/get-node-list
+     */
+    listNodes(query: ListNodesQuery): Promise<ListNodesResponse>
+    /**
+     * 通过链接获取节点
+     * @see https://open.dingtalk.com/document/orgapp/get-node-by-link
+     */
+    getNodeByUrl(
+      query: GetNodeByUrlQuery,
+      params: GetNodeByUrlParams,
+    ): Promise<GetNodeByUrlResponse>
+    /**
+     * 批量获取节点
+     * @see https://open.dingtalk.com/document/orgapp/obtain-nodes-in-batch
+     */
+    getNodes(
+      query: GetNodesQuery,
+      params: GetNodesParams,
+    ): Promise<GetNodesResponse>
+    /**
+     * 获取节点
+     * @see https://open.dingtalk.com/document/orgapp/get-node
+     */
+    getNode(nodeId: string, query: GetNodeQuery): Promise<GetNodeResponse>
+    /**
+     * 根据词条名称获取该词条释义
+     * @see https://open.dingtalk.com/document/orgapp/enterprise-encyclopedia-query-entry-details-by-entry-name
+     */
+    wikiWordsDetail(
+      query: WikiWordsDetailQuery,
+    ): Promise<WikiWordsDetailResponse>
+    /**
+     * 外部传递过来的消息根据百科词库分词
+     * @see https://open.dingtalk.com/document/orgapp/enterprise-encyclopedia-match-entries-in-a-text
+     */
+    wikiWordsParse(
+      params: WikiWordsParseParams,
+    ): Promise<WikiWordsParseResponse>
+  }
+}

package/src/api/workbench.ts

@@ -0,0 +1,73 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface AddRecentUserAppListParams {
+  /** 组织CorpId */
+  corpId: string
+  /** 最近使用应用列表 */
+  usedAppDetailList: object[]
+  /** 员工staffId */
+  userId: string
+}
+
+export interface AddRecentUserAppListResponse {
+  result: unknown
+}
+
+export interface GetPluginRuleCheckInfoQuery {
+  /** 插件的appId。 */
+  miniAppId?: string
+}
+
+export interface GetPluginRuleCheckInfoResponse {
+  packCode?: string
+  pluginRuleCheckDetail?: string
+}
+
+export interface GetPluginPermissionPointQuery {
+  /** 插件ID。 */
+  miniAppId?: string
+}
+
+export interface GetPluginPermissionPointResponse {
+  permissionPointList?: string[]
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/workbench/components/recentUsed/batch': {
+    POST: { addRecentUserAppList: false },
+  },
+  '/workbench/plugins/validationRules': {
+    GET: { getPluginRuleCheckInfo: false },
+  },
+  '/workbench/plugins/permissions': {
+    GET: { getPluginPermissionPoint: false },
+  },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 批量添加最近使用记录
+     * @see https://open.dingtalk.com/document/app/add-recently-used-apps-in-bulk
+     */
+    addRecentUserAppList(
+      params: AddRecentUserAppListParams,
+    ): Promise<AddRecentUserAppListResponse>
+    /**
+     * 获取插件的校验规则
+     * @see https://open.dingtalk.com/document/dashboard/you-can-call-this-operation-to-obtain-the-information-about
+     */
+    getPluginRuleCheckInfo(
+      query: GetPluginRuleCheckInfoQuery,
+    ): Promise<GetPluginRuleCheckInfoResponse>
+    /**
+     * 获取工作台插件的权限点
+     * @see https://open.dingtalk.com/document/dashboard/obtain-the-permissions-of-the-workbench-plug-in
+     */
+    getPluginPermissionPoint(
+      query: GetPluginPermissionPointQuery,
+    ): Promise<GetPluginPermissionPointResponse>
+  }
+}