@satorijs/adapter-lark 3.8.6 → 3.9.1

package/src/types/mdm.ts

@@ -0,0 +1,57 @@
+import { Internal } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 用户数据维度绑定
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/bind
+     */
+    bindMdmUserAuthDataRelation(body: BindMdmUserAuthDataRelationRequest, query?: BindMdmUserAuthDataRelationQuery): Promise<void>
+    /**
+     * 用户数据维度解绑
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/unbind
+     */
+    unbindMdmUserAuthDataRelation(body: UnbindMdmUserAuthDataRelationRequest, query?: UnbindMdmUserAuthDataRelationQuery): Promise<void>
+  }
+}
+
+export interface BindMdmUserAuthDataRelationRequest {
+  /** 数据类型编码 */
+  root_dimension_type: string
+  /** 数据编码列表 */
+  sub_dimension_types: string[]
+  /** 授权人的lark id */
+  authorized_user_ids: string[]
+  /** uams系统中应用id */
+  uams_app_id: string
+}
+
+export interface BindMdmUserAuthDataRelationQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface UnbindMdmUserAuthDataRelationRequest {
+  /** 数据类型编码 */
+  root_dimension_type: string
+  /** 数据编码列表 */
+  sub_dimension_types: string[]
+  /** 授权人的lark id */
+  authorized_user_ids: string[]
+  /** uams系统中应用id */
+  uams_app_id: string
+}
+
+export interface UnbindMdmUserAuthDataRelationQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+Internal.define({
+  '/mdm/v1/user_auth_data_relations/bind': {
+    POST: 'bindMdmUserAuthDataRelation',
+  },
+  '/mdm/v1/user_auth_data_relations/unbind': {
+    POST: 'unbindMdmUserAuthDataRelation',
+  },
+})

package/src/types/minutes.ts

@@ -0,0 +1,46 @@
+import { Minute, Statictics } from '.'
+import { Internal } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 获取妙记统计数据
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-statistics/get
+     */
+    getMinutesMinuteStatistics(minute_token: string, query?: GetMinutesMinuteStatisticsQuery): Promise<GetMinutesMinuteStatisticsResponse>
+    /**
+     * 获取妙记信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute/get
+     */
+    getMinutesMinute(minute_token: string, query?: GetMinutesMinuteQuery): Promise<GetMinutesMinuteResponse>
+  }
+}
+
+export interface GetMinutesMinuteStatisticsQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface GetMinutesMinuteQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface GetMinutesMinuteStatisticsResponse {
+  /** 妙记浏览信息统计 */
+  statistics?: Statictics
+}
+
+export interface GetMinutesMinuteResponse {
+  /** 妙记基本信息 */
+  minute?: Minute
+}
+
+Internal.define({
+  '/minutes/v1/minutes/{minute_token}/statistics': {
+    GET: 'getMinutesMinuteStatistics',
+  },
+  '/minutes/v1/minutes/{minute_token}': {
+    GET: 'getMinutesMinute',
+  },
+})

package/src/types/moments.ts

@@ -0,0 +1,28 @@
+import { Post } from '.'
+import { Internal } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 查询帖子信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/moments-v1/post/get
+     */
+    getMomentsPost(post_id: string, query?: GetMomentsPostQuery): Promise<GetMomentsPostResponse>
+  }
+}
+
+export interface GetMomentsPostQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface GetMomentsPostResponse {
+  /** 帖子实体 */
+  post?: Post
+}
+
+Internal.define({
+  '/moments/v1/posts/{post_id}': {
+    GET: 'getMomentsPost',
+  },
+})

package/src/types/okr.ts

@@ -0,0 +1,261 @@
+import { ContentBlock, OkrBatch, OkrReview, Period, PeriodRule } from '.'
+import { Internal } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 创建 OKR 周期
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create
+     */
+    createOkrPeriod(body: CreateOkrPeriodRequest): Promise<CreateOkrPeriodResponse>
+    /**
+     * 修改 OKR 周期状态
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch
+     */
+    patchOkrPeriod(period_id: string, body: PatchOkrPeriodRequest): Promise<PatchOkrPeriodResponse>
+    /**
+     * 获取 OKR 周期列表
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list
+     */
+    listOkrPeriod(query?: Pagination): Paginated<Period>
+    /**
+     * 获取 OKR 周期规则
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list
+     */
+    listOkrPeriodRule(): Promise<ListOkrPeriodRuleResponse>
+    /**
+     * 获取用户的 OKR 列表
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list
+     */
+    listOkrUserOkr(user_id: string, query?: ListOkrUserOkrQuery): Promise<ListOkrUserOkrResponse>
+    /**
+     * 批量获取 OKR
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/okr/batch_get
+     */
+    batchGetOkr(query?: BatchGetOkrQuery): Promise<BatchGetOkrResponse>
+    /**
+     * 创建 OKR 进展记录
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create
+     */
+    createOkrProgressRecord(body: CreateOkrProgressRecordRequest, query?: CreateOkrProgressRecordQuery): Promise<CreateOkrProgressRecordResponse>
+    /**
+     * 删除 OKR 进展记录
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete
+     */
+    deleteOkrProgressRecord(progress_id: string): Promise<void>
+    /**
+     * 更新 OKR 进展记录
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update
+     */
+    updateOkrProgressRecord(progress_id: string, body: UpdateOkrProgressRecordRequest, query?: UpdateOkrProgressRecordQuery): Promise<UpdateOkrProgressRecordResponse>
+    /**
+     * 获取 OKR 进展记录
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get
+     */
+    getOkrProgressRecord(progress_id: string, query?: GetOkrProgressRecordQuery): Promise<GetOkrProgressRecordResponse>
+    /**
+     * 上传进展记录图片
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload
+     */
+    uploadOkrImage(form: UploadOkrImageForm): Promise<UploadOkrImageResponse>
+    /**
+     * 查询复盘信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query
+     */
+    queryOkrReview(query?: QueryOkrReviewQuery): Promise<QueryOkrReviewResponse>
+  }
+}
+
+export interface CreateOkrPeriodRequest {
+  /** 周期规则 id */
+  period_rule_id: string
+  /** 周期起始年月 */
+  start_month: string
+}
+
+export interface PatchOkrPeriodRequest {
+  /** 周期显示状态 */
+  status: 1 | 2 | 3
+}
+
+export interface ListOkrUserOkrQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
+  /** 请求列表的偏移，offset>=0 */
+  offset: string
+  /** 列表长度，0-10 */
+  limit: string
+  /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn */
+  lang?: string
+  /** period_id列表，最多10个 */
+  period_ids?: string[]
+}
+
+export interface BatchGetOkrQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
+  /** OKR ID 列表，最多10个 */
+  okr_ids: string[]
+  /** 请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn，请求 Query中 */
+  lang?: string
+}
+
+export interface CreateOkrProgressRecordRequest {
+  /** 进展来源 */
+  source_title: string
+  /** 进展来源链接 */
+  source_url: string
+  /** 目标id，与target_type对应 */
+  target_id: string
+  /** 目标类型 */
+  target_type: 2 | 3
+  /** 进展详情 富文本格式 */
+  content: ContentBlock
+  /** pc进展来源链接 */
+  source_url_pc?: string
+  /** mobile进展来源链接 */
+  source_url_mobile?: string
+}
+
+export interface CreateOkrProgressRecordQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface UpdateOkrProgressRecordRequest {
+  /** 进展详情 富文本格式 */
+  content: ContentBlock
+}
+
+export interface UpdateOkrProgressRecordQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface GetOkrProgressRecordQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface UploadOkrImageForm {
+  /** 图片 */
+  data: Blob
+  /** 图片的目标ID */
+  target_id: string
+  /** 图片使用的目标类型 */
+  target_type: 2 | 3
+}
+
+export interface QueryOkrReviewQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
+  /** 目标用户id列表，最多5个 */
+  user_ids: string[]
+  /** period_id列表，最多5个 */
+  period_ids: string[]
+}
+
+export interface CreateOkrPeriodResponse {
+  /** 周期id */
+  period_id?: string
+  /** 周期起始年月 */
+  start_month?: string
+  /** 周期结束年月 */
+  end_month?: string
+}
+
+export interface PatchOkrPeriodResponse {
+  /** 周期规则id */
+  period_id?: string
+  /** 周期显示状态 */
+  status?: 1 | 2 | 3
+}
+
+export interface ListOkrPeriodRuleResponse {
+  /** 指标库列表 */
+  period_rules?: PeriodRule[]
+}
+
+export interface ListOkrUserOkrResponse {
+  /** OKR周期总数 */
+  total?: number
+  /** OKR 列表 */
+  okr_list?: OkrBatch[]
+}
+
+export interface BatchGetOkrResponse {
+  /** OKR 列表 */
+  okr_list?: OkrBatch[]
+}
+
+export interface CreateOkrProgressRecordResponse {
+  /** OKR 进展ID */
+  progress_id?: string
+  /** 进展更新时间 毫秒 */
+  modify_time?: string
+  /** 进展 对应的 Content 详细内容 */
+  content?: ContentBlock
+}
+
+export interface UpdateOkrProgressRecordResponse {
+  /** OKR 进展ID */
+  progress_id?: string
+  /** 进展更新时间 毫秒 */
+  modify_time?: string
+  /** 进展 对应的 Content 详细内容 */
+  content?: ContentBlock
+}
+
+export interface GetOkrProgressRecordResponse {
+  /** OKR 进展ID */
+  progress_id?: string
+  /** 进展更新时间 毫秒 */
+  modify_time?: string
+  /** 进展 对应的 Content 详细内容 */
+  content?: ContentBlock
+}
+
+export interface UploadOkrImageResponse {
+  /** 图片token */
+  file_token?: string
+  /** 图片下载链接 */
+  url?: string
+}
+
+export interface QueryOkrReviewResponse {
+  /** OKR复盘 列表 */
+  review_list?: OkrReview[]
+}
+
+Internal.define({
+  '/okr/v1/periods': {
+    POST: 'createOkrPeriod',
+    GET: { name: 'listOkrPeriod', pagination: { argIndex: 0 } },
+  },
+  '/okr/v1/periods/{period_id}': {
+    PATCH: 'patchOkrPeriod',
+  },
+  '/okr/v1/period_rules': {
+    GET: 'listOkrPeriodRule',
+  },
+  '/okr/v1/users/{user_id}/okrs': {
+    GET: 'listOkrUserOkr',
+  },
+  '/okr/v1/okrs/batch_get': {
+    GET: 'batchGetOkr',
+  },
+  '/okr/v1/progress_records': {
+    POST: 'createOkrProgressRecord',
+  },
+  '/okr/v1/progress_records/{progress_id}': {
+    DELETE: 'deleteOkrProgressRecord',
+    PUT: 'updateOkrProgressRecord',
+    GET: 'getOkrProgressRecord',
+  },
+  '/okr/v1/images/upload': {
+    POST: { name: 'uploadOkrImage', multipart: true },
+  },
+  '/okr/v1/reviews/query': {
+    GET: 'queryOkrReview',
+  },
+})

package/src/types/optical_char_recognition.ts

@@ -0,0 +1,27 @@
+import { Internal } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 识别图片中的文字
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize
+     */
+    basicRecognizeOpticalCharRecognitionImage(body: BasicRecognizeOpticalCharRecognitionImageRequest): Promise<BasicRecognizeOpticalCharRecognitionImageResponse>
+  }
+}
+
+export interface BasicRecognizeOpticalCharRecognitionImageRequest {
+  /** base64 后的图片数据 */
+  image?: string
+}
+
+export interface BasicRecognizeOpticalCharRecognitionImageResponse {
+  /** 按区域识别，返回文本列表 */
+  text_list: string[]
+}
+
+Internal.define({
+  '/optical_char_recognition/v1/image/basic_recognize': {
+    POST: 'basicRecognizeOpticalCharRecognitionImage',
+  },
+})

package/src/types/passport.ts

@@ -0,0 +1,61 @@
+import { MaskSession } from '.'
+import { Internal } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 批量获取脱敏的用户登录信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/query
+     */
+    queryPassportSession(body: QueryPassportSessionRequest, query?: QueryPassportSessionQuery): Promise<QueryPassportSessionResponse>
+    /**
+     * 退出登录
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/logout
+     */
+    logoutPassportSession(body: LogoutPassportSessionRequest, query?: LogoutPassportSessionQuery): Promise<void>
+  }
+}
+
+export interface QueryPassportSessionRequest {
+  /** 用户 ID */
+  user_ids?: string[]
+}
+
+export interface QueryPassportSessionQuery {
+  /** 用户id类型 */
+  user_id_type?: 'open_id' | 'union_id' | 'user_id'
+}
+
+export interface LogoutPassportSessionRequest {
+  /** idp 侧的唯一标识 */
+  idp_credential_id?: string
+  /** 登出的方式 */
+  logout_type: 1 | 2 | 3
+  /** 登出的客户端类型，默认全部登出，1-桌面端，2-网页端，3-安卓移动端，4-Apple移动端 5-服务端 6-旧版小程序端 8-其他移动端 */
+  terminal_type?: number[]
+  /** user_id */
+  user_id?: string
+  /** 登出原因 */
+  logout_reason?: number
+  /** 需要精确登出的 session 标识符 */
+  sid?: string
+}
+
+export interface LogoutPassportSessionQuery {
+  /** user_id_type */
+  user_id_type?: 'open_id' | 'union_id' | 'user_id'
+}
+
+export interface QueryPassportSessionResponse {
+  /** session信息 */
+  mask_sessions?: MaskSession[]
+}
+
+Internal.define({
+  '/passport/v1/sessions/query': {
+    POST: 'queryPassportSession',
+  },
+  '/passport/v1/sessions/logout': {
+    POST: 'logoutPassportSession',
+  },
+})

package/src/types/payroll.ts

@@ -0,0 +1,69 @@
+import { AcctItem, CostAllocationPlan, CostAllocationReportData, I18nContent, Paygroup } from '.'
+import { Internal, Pagination } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 批量查询算薪项
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/acct_item/list
+     */
+    listPayrollAcctItem(query?: Pagination): Paginated<AcctItem>
+    /**
+     * 查询成本分摊报表汇总数据
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_report/list
+     */
+    listPayrollCostAllocationReport(query?: ListPayrollCostAllocationReportQuery): Promise<ListPayrollCostAllocationReportResponse>
+    /**
+     * 批量查询成本分摊方案
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/cost_allocation_plan/list
+     */
+    listPayrollCostAllocationPlan(query?: ListPayrollCostAllocationPlanQuery): Paginated<CostAllocationPlan>
+    /**
+     * 获取薪资组基本信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/payroll-v1/paygroup/list
+     */
+    listPayrollPaygroup(query?: Pagination): Paginated<Paygroup>
+  }
+}
+
+export interface ListPayrollCostAllocationReportQuery extends Pagination {
+  /** 成本分摊方案ID */
+  cost_allocation_plan_id: string
+  /** 期间 */
+  pay_period: string
+  /** 报表类型 */
+  report_type: 0 | 1 | 2
+}
+
+export interface ListPayrollCostAllocationPlanQuery extends Pagination {
+  /** 期间 */
+  pay_period: string
+}
+
+export interface ListPayrollCostAllocationReportResponse {
+  /** 期间 */
+  pay_period?: string
+  /** 下一页开始 */
+  page_token?: string
+  /** 是否还有更多数据 */
+  has_more?: boolean
+  /** 报表名称 */
+  cost_allocation_report_names?: I18nContent[]
+  /** 汇总数据 */
+  cost_allocation_report_datas?: CostAllocationReportData[]
+}
+
+Internal.define({
+  '/payroll/v1/acct_items': {
+    GET: { name: 'listPayrollAcctItem', pagination: { argIndex: 0 } },
+  },
+  '/payroll/v1/cost_allocation_reports': {
+    GET: 'listPayrollCostAllocationReport',
+  },
+  '/payroll/v1/cost_allocation_plans': {
+    GET: { name: 'listPayrollCostAllocationPlan', pagination: { argIndex: 0 } },
+  },
+  '/payroll/v1/paygroups': {
+    GET: { name: 'listPayrollPaygroup', pagination: { argIndex: 0 } },
+  },
+})