@satorijs/adapter-dingtalk 2.0.3 → 2.0.5

package/src/api/devicemng.ts

@@ -0,0 +1,202 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface ListMaintainInfoParams {
+  /** 页码，从1开始。 */
+  pageNumber?: number
+  /** 页面大小，最大值20。 */
+  pageSize?: number
+  /** 设备uuIi列表，最大值10。 */
+  deviceUuid?: string[]
+}
+
+export interface ListMaintainInfoResponse {
+  totalCount?: number
+  success?: unknown
+  result?: {
+    gmtCreate?: string
+    deviceCode?: string
+    deviceName?: string
+    remark?: string
+    maintenanceStaff?: number
+    processState?: number
+    handleTime?: string
+  }[]
+}
+
+export interface ListInspectInfoParams {
+  /** 当前页码，从1开始。 */
+  pageNumber?: number
+  /** 当页大小，最大值20。 */
+  pageSize?: number
+  /** 设备uuIi列表，最大值10。 */
+  deviceUuid?: string[]
+  /** 类型。 */
+  type?: string
+}
+
+export interface ListInspectInfoResponse {
+  totalCount?: number
+  success?: unknown
+  result?: {
+    deviceName?: string
+    deviceCode?: string
+    type?: string
+    status?: number
+    repairStatus?: number
+    maintenanceStaff?: number
+    handleTime?: string
+    remark?: string
+    name?: string
+    gmtCreate?: string
+  }[]
+}
+
+export interface ListActivateDevicesQuery {
+  /** 设备型号。 */
+  deviceTypeId?: string
+  /** 当前页码，从1开始。 */
+  pageNumber?: number
+  /** 分组标识。 */
+  groupId?: string
+  /** 每页大小，最大值50。 */
+  pageSize?: number
+  /** 设备编号。 */
+  deviceCode?: string
+  /** 设备分类。 */
+  deviceCategory?: number
+}
+
+export interface ListActivateDevicesResponse {
+  totalCount?: number
+  success?: unknown
+  result?: {
+    bizExt?: string
+    deviceCallbackUrl?: string
+    deviceCode?: string
+    deviceDetailUrl?: string
+    deviceName?: string
+    groupUuid?: string
+    icon?: string
+    introduction?: string
+    typeUuid?: string
+    uuid?: string
+    deviceCategory?: number
+  }[]
+}
+
+export interface RegisterAndActivateDeviceBatchParams {
+  /** 设备信息。 */
+  registerAndActivateVOS?: object[]
+}
+
+export interface RegisterAndActivateDeviceBatchResponse {
+  successItems?: {
+    errorCode?: string
+    errorMsg?: string
+    result?: number
+    success?: number
+  }[]
+  success?: unknown
+  failItems?: {
+    errorCode?: string
+    errorMsg?: string
+    result?: number
+    success?: number
+  }[]
+}
+
+export interface RegisterAndActivateDeviceParams {
+  /** 设备号。 */
+  deviceCode: string
+  /** 设备名称。 */
+  deviceName: string
+  /** 设备的简介。 */
+  introduction?: string
+  /** 设备型号。 */
+  typeUuid?: string
+  /** 设备管理员的userId列表。 */
+  userIds?: string[]
+  /** 角色标识。 */
+  roleUuid?: string
+  /** 设备详情链接，最大长度2048字符。 */
+  deviceDetailUrl?: string
+  /** 设备回调链接，最大长度2048字符。 */
+  deviceCallbackUrl?: string
+  /** 设备分类。 */
+  deviceCategory?: number
+}
+
+export interface RegisterAndActivateDeviceResponse {
+  success?: unknown
+  result: {
+    deviceCode: string
+    deviceUuid: string
+    deviceName: string
+    introduction: string
+    typeUuid: string
+    roleUuid: string
+    deviceDetailUrl: string
+    userIds: number
+    deviceCategory?: number
+  }
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/devicemng/customers/devices/maintainInfos/query': {
+    POST: { listMaintainInfo: false },
+  },
+  '/devicemng/customers/devices/inspectInfos/query': {
+    POST: { listInspectInfo: false },
+  },
+  '/devicemng/customers/devices/activations/infos': {
+    GET: { listActivateDevices: false },
+  },
+  '/devicemng/customers/devices/registrationActivations/batch': {
+    POST: { registerAndActivateDeviceBatch: false },
+  },
+  '/devicemng/customers/devices/registerAndActivate': {
+    POST: { registerAndActivateDevice: false },
+  },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 获取报修信息
+     * @see https://open.dingtalk.com/document/isvapp/obtain-the-repair-report-record
+     */
+    listMaintainInfo(
+      params: ListMaintainInfoParams,
+    ): Promise<ListMaintainInfoResponse>
+    /**
+     * 获取巡检、保养记录
+     * @see https://open.dingtalk.com/document/isvapp/obtain-inspection-and-maintenance-records
+     */
+    listInspectInfo(
+      params: ListInspectInfoParams,
+    ): Promise<ListInspectInfoResponse>
+    /**
+     * 查询激活的设备信息
+     * @see https://open.dingtalk.com/document/isvapp/query-information-about-a-registered-device
+     */
+    listActivateDevices(
+      query: ListActivateDevicesQuery,
+    ): Promise<ListActivateDevicesResponse>
+    /**
+     * 批量注册与激活设备
+     * @see https://open.dingtalk.com/document/isvapp/register-and-activate-devices-in-batches
+     */
+    registerAndActivateDeviceBatch(
+      params: RegisterAndActivateDeviceBatchParams,
+    ): Promise<RegisterAndActivateDeviceBatchResponse>
+    /**
+     * 注册与激活设备
+     * @see https://open.dingtalk.com/document/isvapp/register-the-device-to-the-dingtalk
+     */
+    registerAndActivateDevice(
+      params: RegisterAndActivateDeviceParams,
+    ): Promise<RegisterAndActivateDeviceResponse>
+  }
+}

package/src/api/diot.ts

@@ -0,0 +1,19 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface UpgradeDeviceResponse {
+  requestId?: string
+}
+
+// funcName: isOldApi
+Internal.define({ '/diot/upgrade/device': { POST: { upgradeDevice: false } } })
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 升级设备
+     * @see https://open.dingtalk.com/document/app/upgrade-equipment
+     */
+    upgradeDevice(): Promise<UpgradeDeviceResponse>
+  }
+}

package/src/api/doc.ts

@@ -0,0 +1,232 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface SetRowsVisibilityParams {
+  /** 可见性。 */
+  visibility: string
+  /** 要显示或者隐藏的第一行的游标，从0开始。 */
+  row: number
+  /** 要显示或隐藏的行的数量。 */
+  rowCount: number
+}
+
+export interface SetRowsVisibilityQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface SetRowsVisibilityResponse {
+  id?: string
+}
+
+export interface SetColumnsVisibilityParams {
+  /** 要显示或隐藏的第一列的游标，从0开始。 */
+  column: number
+  /** 要显示或隐藏的列的数量。 */
+  columnCount: number
+  /** 可见性。 */
+  visibility: string
+}
+
+export interface SetColumnsVisibilityQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface SetColumnsVisibilityResponse {
+  id?: string
+}
+
+export interface DeleteRowsParams {
+  /** 要删除的第一行的游标，从0开始。 */
+  row: number
+  /** 要删除的行的数量。 */
+  rowCount: number
+}
+
+export interface DeleteRowsQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface DeleteRowsResponse {
+  id?: string
+}
+
+export interface DeleteColumnsParams {
+  /** 要删除的第一列的游标，从0开始。 */
+  column: number
+  /** 要删除的列的数量。 */
+  columnCount: number
+}
+
+export interface DeleteColumnsQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface DeleteColumnsResponse {
+  id?: string
+}
+
+export interface InsertRowsBeforeParams {
+  /** 指定行的游标，从0开始。 */
+  row: number
+  /** 插入行的数量。 */
+  rowCount: number
+}
+
+export interface InsertRowsBeforeQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface InsertRowsBeforeResponse {
+  id?: string
+}
+
+export interface InsertColumnsBeforeParams {
+  /** 指定列的游标，从0开始。 */
+  column: number
+  /** 插入列的数量。 */
+  columnCount: number
+}
+
+export interface InsertColumnsBeforeQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface InsertColumnsBeforeResponse {
+  id?: string
+}
+
+export interface ClearQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface ClearResponse {
+  a1Notation?: string
+}
+
+export interface ClearDataQuery {
+  /** 操作人unionId。 */
+  operatorId: string
+}
+
+export interface ClearDataResponse {
+  a1Notation?: string
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/setRowsVisibility': {
+    POST: { setRowsVisibility: false },
+  },
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/setColumnsVisibility': {
+    POST: { setColumnsVisibility: false },
+  },
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/deleteRows': {
+    POST: { deleteRows: false },
+  },
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/deleteColumns': {
+    POST: { deleteColumns: false },
+  },
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/insertRowsBefore': {
+    POST: { insertRowsBefore: false },
+  },
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/insertColumnsBefore': {
+    POST: { insertColumnsBefore: false },
+  },
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/clear': {
+    POST: { clear: false },
+  },
+  '/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/clearData':
+    { POST: { clearData: false } },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 设置行隐藏或显示
+     * @see https://open.dingtalk.com/document/app/set-row-visibility
+     */
+    setRowsVisibility(
+      workbookId: string,
+      sheetId: string,
+      query: SetRowsVisibilityQuery,
+      params: SetRowsVisibilityParams,
+    ): Promise<SetRowsVisibilityResponse>
+    /**
+     * 设置列隐藏或显示
+     * @see https://open.dingtalk.com/document/app/set-column-visibility
+     */
+    setColumnsVisibility(
+      workbookId: string,
+      sheetId: string,
+      query: SetColumnsVisibilityQuery,
+      params: SetColumnsVisibilityParams,
+    ): Promise<SetColumnsVisibilityResponse>
+    /**
+     * 删除行
+     * @see https://open.dingtalk.com/document/app/delete-row
+     */
+    deleteRows(
+      workbookId: string,
+      sheetId: string,
+      query: DeleteRowsQuery,
+      params: DeleteRowsParams,
+    ): Promise<DeleteRowsResponse>
+    /**
+     * 删除列
+     * @see https://open.dingtalk.com/document/app/delete-column
+     */
+    deleteColumns(
+      workbookId: string,
+      sheetId: string,
+      query: DeleteColumnsQuery,
+      params: DeleteColumnsParams,
+    ): Promise<DeleteColumnsResponse>
+    /**
+     * 指定行上方插入若干行
+     * @see https://open.dingtalk.com/document/app/insert-rows-before-rows
+     */
+    insertRowsBefore(
+      workbookId: string,
+      sheetId: string,
+      query: InsertRowsBeforeQuery,
+      params: InsertRowsBeforeParams,
+    ): Promise<InsertRowsBeforeResponse>
+    /**
+     * 指定列左侧插入若干列
+     * @see https://open.dingtalk.com/document/app/insert-column-before-column
+     */
+    insertColumnsBefore(
+      workbookId: string,
+      sheetId: string,
+      query: InsertColumnsBeforeQuery,
+      params: InsertColumnsBeforeParams,
+    ): Promise<InsertColumnsBeforeResponse>
+    /**
+     * 清除单元格区域内所有内容
+     * @see https://open.dingtalk.com/document/app/clear-all
+     */
+    clear(
+      workbookId: string,
+      sheetId: string,
+      rangeAddress: string,
+      query: ClearQuery,
+    ): Promise<ClearResponse>
+    /**
+     * 清除单元格区域内数据
+     * @see https://open.dingtalk.com/document/app/clear-cell-data
+     */
+    clearData(
+      workbookId: string,
+      sheetId: string,
+      rangeAddress: string,
+      query: ClearDataQuery,
+    ): Promise<ClearDataResponse>
+  }
+}

package/src/api/drive.ts

@@ -0,0 +1,109 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface AddCustomSpaceParams {
+  /** 自定义空间标识。任意小于10位的字符串即可。 */
+  identifier: string
+  /** 业务类型。任意小于8位的字符串即可。 */
+  bizType: string
+  /** 授权模式，取值： */
+  permissionMode: string
+  /** 用户unionId，可通过以下两种方式获取： */
+  unionId: string
+}
+
+export interface AddCustomSpaceResponse {
+  spaceId: string
+  spaceName?: string
+  spaceType: string
+  quota?: number
+  usedQuota: number
+  permissionMode?: string
+  createTime?: string
+  modifyTime?: string
+}
+
+export interface DeleteSpaceQuery {
+  /** 用户unionId，可通过以下两种方式获取： */
+  unionId: string
+}
+
+export interface DriveAddSpaceParams {
+  /** 空间名称（不能为空）。 */
+  name: string
+  /** 用户unionId，可通过以下两种方式获取： */
+  unionId: string
+}
+
+export interface DriveAddSpaceResponse {
+  spaceId: string
+  spaceName?: string
+  spaceType: string
+  quota?: number
+  usedQuota: number
+  permissionMode?: string
+  createTime?: string
+  modifyTime?: string
+}
+
+export interface ListSpacesQuery {
+  /** 用户unionId，可通过以下两种方式获取： */
+  unionId: string
+  /** 空间类型。 */
+  spaceType: string
+  /** 分页游标。 */
+  nextToken?: string
+  /** 分页大小。 */
+  maxResults: number
+}
+
+export interface ListSpacesResponse {
+  spaces: {
+    spaceId: string
+    spaceName?: string
+    spaceType: string
+    quota?: number
+    usedQuota: number
+    permissionMode?: string
+    createTime?: string
+    modifyTime?: string
+  }[]
+  nextToken?: string
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/drive/spaces/customSpaces': { POST: { addCustomSpace: false } },
+  '/drive/spaces/{spaceId}': { DELETE: { deleteSpace: false } },
+  '/drive/spaces': {
+    POST: { driveAddSpace: false },
+    GET: { listSpaces: false },
+  },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 新建自定义空间
+     * @see https://open.dingtalk.com/document/isvapp/new-custom-space
+     */
+    addCustomSpace(
+      params: AddCustomSpaceParams,
+    ): Promise<AddCustomSpaceResponse>
+    /**
+     * 删除空间
+     * @see https://open.dingtalk.com/document/isvapp/delete-a-space
+     */
+    deleteSpace(spaceId: string, query: DeleteSpaceQuery): Promise<void>
+    /**
+     * 新建空间
+     * @see https://open.dingtalk.com/document/isvapp/new-space
+     */
+    driveAddSpace(params: DriveAddSpaceParams): Promise<DriveAddSpaceResponse>
+    /**
+     * 获取空间列表
+     * @see https://open.dingtalk.com/document/isvapp/queries-a-space-list
+     */
+    listSpaces(query: ListSpacesQuery): Promise<ListSpacesResponse>
+  }
+}

package/src/api/edu.ts

@@ -0,0 +1,30 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface MoveStudentParams {
+  /** 操作者的userid，可调用[通过免登码获取用户信息](https://open.dingtalk.com/document/app/obtain-the-userid-of-a-user-by-using-the-log-free)接口获取。 */
+  operator: string
+  /** 学生的userid，可调用[获取人员列表](https://open.dingtalk.com/document/app/obtains-a-list-of-home-school-user-identities)接口获取。 */
+  userId: string
+  /** 原班级ID，可调用[获取部门列表](https://open.dingtalk.com/document/app/obtains-the-department-node-list)接口获取。 */
+  originClassId: number
+  /** 目标班级ID，可调用[获取部门列表](https://open.dingtalk.com/document/app/obtains-the-department-node-list)接口获取。 */
+  targetClassId: number
+}
+
+export interface MoveStudentResponse {
+  success?: unknown
+}
+
+// funcName: isOldApi
+Internal.define({ '/edu/students/move': { POST: { moveStudent: false } } })
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 学生调班
+     * @see https://open.dingtalk.com/document/isvapp/shift-students
+     */
+    moveStudent(params: MoveStudentParams): Promise<MoveStudentResponse>
+  }
+}

package/src/api/esign.ts

@@ -0,0 +1,44 @@
+import { Internal } from '../internal'
+// GENERATED CONTENT
+
+export interface GetFlowDocsResponse {
+  data?: {
+    fileId?: string
+    fileName?: string
+    fileUrl?: string
+  }[]
+}
+
+export interface ApprovalListResponse {
+  data?: {
+    approvalName?: string
+    status?: string
+    refuseReason?: string
+    sponsorAccountName?: string
+    startTime?: number
+    endTime?: number
+    sealIdImg?: string
+    approvalNodes?: number
+  }[]
+}
+
+// funcName: isOldApi
+Internal.define({
+  '/esign/flowTasks/{taskId}/docs': { GET: { getFlowDocs: false } },
+  '/esign/approvals/{taskId}': { GET: { approvalList: false } },
+})
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 获取流程任务的所有合同列表
+     * @see https://open.dingtalk.com/document/isvapp/get-a-list-of-all-contracts-for-the-process-task
+     */
+    getFlowDocs(taskId: string): Promise<GetFlowDocsResponse>
+    /**
+     * 获取流程任务用印审批列表
+     * @see https://open.dingtalk.com/document/isvapp/obtains-the-print-approval-list-for-process-tasks
+     */
+    approvalList(taskId: string): Promise<ApprovalListResponse>
+  }
+}