@satorijs/adapter-lark 3.9.0 → 3.9.2

package/src/types/okr.ts

@@ -73,9 +73,48 @@ export interface CreateOkrPeriodRequest {
   start_month: string
 }
 
+export interface CreateOkrPeriodResponse {
+  /** 周期id */
+  period_id?: string
+  /** 周期起始年月 */
+  start_month?: string
+  /** 周期结束年月 */
+  end_month?: string
+}
+
+export const enum PatchOkrPeriodRequestStatus {
+  /** 正常状态 */
+  NormalStatus = 1,
+  /** 标记失效 */
+  MarkInvalid = 2,
+  /** 隐藏周期 */
+  HiddenPeriod = 3,
+}
+
 export interface PatchOkrPeriodRequest {
   /** 周期显示状态 */
-  status: 1 | 2 | 3
+  status: PatchOkrPeriodRequestStatus
+}
+
+export const enum PatchOkrPeriodResponseStatus {
+  /** 正常状态 */
+  NormalStatus = 1,
+  /** 标记失效 */
+  MarkInvalid = 2,
+  /** 隐藏周期 */
+  HiddenPeriod = 3,
+}
+
+export interface PatchOkrPeriodResponse {
+  /** 周期规则id */
+  period_id?: string
+  /** 周期显示状态 */
+  status?: PatchOkrPeriodResponseStatus
+}
+
+export interface ListOkrPeriodRuleResponse {
+  /** 指标库列表 */
+  period_rules?: PeriodRule[]
 }
 
 export interface ListOkrUserOkrQuery {
@@ -91,6 +130,13 @@ export interface ListOkrUserOkrQuery {
   period_ids?: string[]
 }
 
+export interface ListOkrUserOkrResponse {
+  /** OKR周期总数 */
+  total?: number
+  /** OKR 列表 */
+  okr_list?: OkrBatch[]
+}
+
 export interface BatchGetOkrQuery {
   /** 此次调用中使用的用户ID的类型 */
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
@@ -100,6 +146,18 @@ export interface BatchGetOkrQuery {
   lang?: string
 }
 
+export interface BatchGetOkrResponse {
+  /** OKR 列表 */
+  okr_list?: OkrBatch[]
+}
+
+export const enum CreateOkrProgressRecordRequestTargetType {
+  /** okr的O */
+  Objective = 2,
+  /** okr的KR */
+  KeyResult = 3,
+}
+
 export interface CreateOkrProgressRecordRequest {
   /** 进展来源 */
   source_title: string
@@ -108,7 +166,7 @@ export interface CreateOkrProgressRecordRequest {
   /** 目标id，与target_type对应 */
   target_id: string
   /** 目标类型 */
-  target_type: 2 | 3
+  target_type: CreateOkrProgressRecordRequestTargetType
   /** 进展详情 富文本格式 */
   content: ContentBlock
   /** pc进展来源链接 */
@@ -122,6 +180,15 @@ export interface CreateOkrProgressRecordQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface CreateOkrProgressRecordResponse {
+  /** OKR 进展ID */
+  progress_id?: string
+  /** 进展更新时间 毫秒 */
+  modify_time?: string
+  /** 进展 对应的 Content 详细内容 */
+  content?: ContentBlock
+}
+
 export interface UpdateOkrProgressRecordRequest {
   /** 进展详情 富文本格式 */
   content: ContentBlock
@@ -132,63 +199,7 @@ export interface UpdateOkrProgressRecordQuery {
   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 {
+export interface UpdateOkrProgressRecordResponse {
   /** OKR 进展ID */
   progress_id?: string
   /** 进展更新时间 毫秒 */
@@ -197,13 +208,9 @@ export interface CreateOkrProgressRecordResponse {
   content?: ContentBlock
 }
 
-export interface UpdateOkrProgressRecordResponse {
-  /** OKR 进展ID */
-  progress_id?: string
-  /** 进展更新时间 毫秒 */
-  modify_time?: string
-  /** 进展 对应的 Content 详细内容 */
-  content?: ContentBlock
+export interface GetOkrProgressRecordQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
 export interface GetOkrProgressRecordResponse {
@@ -215,6 +222,22 @@ export interface GetOkrProgressRecordResponse {
   content?: ContentBlock
 }
 
+export const enum UploadOkrImageFormTargetType {
+  /** okr的O */
+  Objective = 2,
+  /** okr的KR */
+  KeyResult = 3,
+}
+
+export interface UploadOkrImageForm {
+  /** 图片 */
+  data: Blob
+  /** 图片的目标ID */
+  target_id: string
+  /** 图片使用的目标类型 */
+  target_type: UploadOkrImageFormTargetType
+}
+
 export interface UploadOkrImageResponse {
   /** 图片token */
   file_token?: string
@@ -222,6 +245,15 @@ export interface UploadOkrImageResponse {
   url?: string
 }
 
+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 QueryOkrReviewResponse {
   /** OKR复盘 列表 */
   review_list?: OkrReview[]

package/src/types/passport.ts

@@ -26,11 +26,25 @@ export interface QueryPassportSessionQuery {
   user_id_type?: 'open_id' | 'union_id' | 'user_id'
 }
 
+export interface QueryPassportSessionResponse {
+  /** session信息 */
+  mask_sessions?: MaskSession[]
+}
+
+export const enum LogoutPassportSessionRequestLogoutType {
+  /** UserID */
+  UserID = 1,
+  /** IdpCredentialID */
+  IdpCredentialID = 2,
+  /** Session 标识符 */
+  SessionUUID = 3,
+}
+
 export interface LogoutPassportSessionRequest {
   /** idp 侧的唯一标识 */
   idp_credential_id?: string
   /** 登出的方式 */
-  logout_type: 1 | 2 | 3
+  logout_type: LogoutPassportSessionRequestLogoutType
   /** 登出的客户端类型，默认全部登出，1-桌面端，2-网页端，3-安卓移动端，4-Apple移动端 5-服务端 6-旧版小程序端 8-其他移动端 */
   terminal_type?: number[]
   /** user_id */
@@ -46,11 +60,6 @@ export interface LogoutPassportSessionQuery {
   user_id_type?: 'open_id' | 'union_id' | 'user_id'
 }
 
-export interface QueryPassportSessionResponse {
-  /** session信息 */
-  mask_sessions?: MaskSession[]
-}
-
 Internal.define({
   '/passport/v1/sessions/query': {
     POST: 'queryPassportSession',

package/src/types/payroll.ts

@@ -26,18 +26,22 @@ declare module '../internal' {
   }
 }
 
+export const enum ListPayrollCostAllocationReportQueryReportType {
+  /** 默认 */
+  Default = 0,
+  /** 计提 */
+  Accrued = 1,
+  /** 实发 */
+  Paid = 2,
+}
+
 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
+  report_type: ListPayrollCostAllocationReportQueryReportType
 }
 
 export interface ListPayrollCostAllocationReportResponse {
@@ -53,6 +57,11 @@ export interface ListPayrollCostAllocationReportResponse {
   cost_allocation_report_datas?: CostAllocationReportData[]
 }
 
+export interface ListPayrollCostAllocationPlanQuery extends Pagination {
+  /** 期间 */
+  pay_period: string
+}
+
 Internal.define({
   '/payroll/v1/acct_items': {
     GET: { name: 'listPayrollAcctItem', pagination: { argIndex: 0 } },

package/src/types/performance.ts

@@ -121,6 +121,11 @@ export interface ListPerformanceV1SemesterQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface ListPerformanceV1SemesterResponse {
+  /** 周期meta信息列表 */
+  items?: Semester[]
+}
+
 export interface QueryPerformanceV2ActivityRequest {
   /** 评估周期 ID 列表，获取指定评估周期的项目 ID，semester_id 可通过【获取周期】接口获得 */
   semester_ids?: string[]
@@ -132,6 +137,11 @@ export interface QueryPerformanceV2ActivityQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface QueryPerformanceV2ActivityResponse {
+  /** 绩效评估项目列表。 */
+  activities?: Activity[]
+}
+
 export interface QueryPerformanceV2AdditionalInformationRequest {
   /** 评估周期 ID 列表，semester_id 可通过【获取周期】接口获得 */
   semester_id: string
@@ -162,6 +172,13 @@ export interface ImportPerformanceV2AdditionalInformationQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface ImportPerformanceV2AdditionalInformationResponse {
+  /** 导入记录 ID */
+  import_record_id?: string
+  /** 成功导入后的补充信息列表 */
+  additional_informations?: AdditionalInformation[]
+}
+
 export interface DeletePerformanceV2AdditionalInformationsBatchRequest {
   /** 评估周期 ID 列表，semester_id 可通过【获取周期】接口获得 */
   semester_id: string
@@ -173,11 +190,23 @@ export interface DeletePerformanceV2AdditionalInformationsBatchQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface DeletePerformanceV2AdditionalInformationsBatchResponse {
+  /** 被删除的补充信息列表 */
+  additional_informations?: string[]
+}
+
+export const enum WritePerformanceV2UserGroupUserRelRequestScopeVisibleSetting {
+  /** 无限制 */
+  NotLimit = 0,
+  /** 后台管理员不可见 */
+  BackendAdminNotVisible = 1,
+}
+
 export interface WritePerformanceV2UserGroupUserRelRequest {
   /** 分组id key */
   group_id?: string
   /** 人员组查看人员名单可见性配置 */
-  scope_visible_setting?: 0 | 1
+  scope_visible_setting?: WritePerformanceV2UserGroupUserRelRequestScopeVisibleSetting
   /** 人员列表 */
   user_ids?: string[]
 }
@@ -189,6 +218,11 @@ export interface WritePerformanceV2UserGroupUserRelQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface WritePerformanceV2UserGroupUserRelResponse {
+  /** 写入员工范围响应 */
+  data?: WriteUserGroupScopeData
+}
+
 export interface QueryPerformanceV2RevieweeRequest {
   /** 周期 ID，1 次只允许查询 1 个周期，semester_id 可通过【获取周期】接口获得 */
   semester_id: string
@@ -202,6 +236,17 @@ export interface QueryPerformanceV2RevieweeQuery extends Pagination {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface QueryPerformanceV2RevieweeResponse {
+  /** 周期ID */
+  semester_id?: string
+  /** 被评估人列表 */
+  reviewees?: Reviewee[]
+  /** 是否还有更多项 */
+  has_more?: boolean
+  /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */
+  page_token?: string
+}
+
 export interface QueryPerformanceV2ReviewTemplateRequest {
   /** 评估模板 ID 列表，获取指定评估模板的配置数据。如果不传则返回所有 */
   review_template_ids?: string[]
@@ -250,6 +295,11 @@ export interface QueryPerformanceV2MetricFieldRequest {
   field_ids?: string[]
 }
 
+export interface QueryPerformanceV2MetricFieldResponse {
+  /** 指标字段信息 */
+  items?: MetricField[]
+}
+
 export interface ListPerformanceV2MetricTagQuery extends Pagination {
   /** 指标标签 ID 列表 */
   tag_ids?: string[]
@@ -273,6 +323,13 @@ export interface FindByUserListPerformanceV1StageTaskQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface FindByUserListPerformanceV1StageTaskResponse {
+  /** 周期基础信息 */
+  base?: SemesterBaseInfo
+  /** 周期环节信息列表 */
+  items?: StageTask[]
+}
+
 export interface FindByPagePerformanceV1StageTaskRequest {
   /** 周期ID，可以通过「查询周期」接口获得 */
   semester_id: string
@@ -293,6 +350,17 @@ export interface FindByPagePerformanceV1StageTaskQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface FindByPagePerformanceV1StageTaskResponse {
+  /** 周期基础信息 */
+  base?: SemesterBaseInfo
+  /** 周期环节信息列表 */
+  items?: StageTask[]
+  /** 是否有下一页数据 */
+  has_more?: boolean
+  /** 下一页分页的token */
+  page_token?: string
+}
+
 export interface QueryPerformanceV2MetricDetailRequest {
   /** 周期 ID，1 次只允许查询 1 个周期，semester_id 可通过【获取周期】接口获得 */
   semester_id: string
@@ -304,6 +372,13 @@ export interface QueryPerformanceV2MetricDetailQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface QueryPerformanceV2MetricDetailResponse {
+  /** 周期ID */
+  semester_id?: string
+  /** 指标明细列表 */
+  reviewee_metrics?: RevieweeMetric[]
+}
+
 export interface ImportPerformanceV2MetricDetailRequest {
   /** 周期 ID，semester_id 可通过【获取周期】接口获得 */
   semester_id: string
@@ -320,6 +395,11 @@ export interface ImportPerformanceV2MetricDetailQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface ImportPerformanceV2MetricDetailResponse {
+  /** 成功时返回导入记录 ID，失败时则为 null */
+  import_record_id?: string
+}
+
 export interface QueryPerformanceV1ReviewDataRequest {
   /** 查询范围的开始日期，毫秒级时间戳，开始日期不能晚于截止日期 */
   start_time: string
@@ -342,6 +422,23 @@ export interface QueryPerformanceV1ReviewDataQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
+export interface QueryPerformanceV1ReviewDataResponse {
+  /** 绩效评估周期列表 */
+  semesters?: Semester[]
+  /** 绩效评估项目列表 */
+  activities?: Activity[]
+  /** 评估项列表 */
+  indicators?: Indicator[]
+  /** 评估模板列表 */
+  templates?: Template[]
+  /** 评估内容列表 */
+  units?: Unit[]
+  /** 填写项列表 */
+  fields?: Field[]
+  /** 评估数据列表 */
+  datas?: ReviewProfile[]
+}
+
 export interface QueryPerformanceV2ReviewDataRequest {
   /** 评估周期 ID 列表，semester_id 可通过【获取周期】 */
   semester_ids: string[]
@@ -365,96 +462,6 @@ export interface QueryPerformanceV2ReviewDataQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id'
 }
 
-export interface ListPerformanceV1SemesterResponse {
-  /** 周期meta信息列表 */
-  items?: Semester[]
-}
-
-export interface QueryPerformanceV2ActivityResponse {
-  /** 绩效评估项目列表。 */
-  activities?: Activity[]
-}
-
-export interface ImportPerformanceV2AdditionalInformationResponse {
-  /** 导入记录 ID */
-  import_record_id?: string
-  /** 成功导入后的补充信息列表 */
-  additional_informations?: AdditionalInformation[]
-}
-
-export interface DeletePerformanceV2AdditionalInformationsBatchResponse {
-  /** 被删除的补充信息列表 */
-  additional_informations?: string[]
-}
-
-export interface WritePerformanceV2UserGroupUserRelResponse {
-  /** 写入员工范围响应 */
-  data?: WriteUserGroupScopeData
-}
-
-export interface QueryPerformanceV2RevieweeResponse {
-  /** 周期ID */
-  semester_id?: string
-  /** 被评估人列表 */
-  reviewees?: Reviewee[]
-  /** 是否还有更多项 */
-  has_more?: boolean
-  /** 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token */
-  page_token?: string
-}
-
-export interface QueryPerformanceV2MetricFieldResponse {
-  /** 指标字段信息 */
-  items?: MetricField[]
-}
-
-export interface FindByUserListPerformanceV1StageTaskResponse {
-  /** 周期基础信息 */
-  base?: SemesterBaseInfo
-  /** 周期环节信息列表 */
-  items?: StageTask[]
-}
-
-export interface FindByPagePerformanceV1StageTaskResponse {
-  /** 周期基础信息 */
-  base?: SemesterBaseInfo
-  /** 周期环节信息列表 */
-  items?: StageTask[]
-  /** 是否有下一页数据 */
-  has_more?: boolean
-  /** 下一页分页的token */
-  page_token?: string
-}
-
-export interface QueryPerformanceV2MetricDetailResponse {
-  /** 周期ID */
-  semester_id?: string
-  /** 指标明细列表 */
-  reviewee_metrics?: RevieweeMetric[]
-}
-
-export interface ImportPerformanceV2MetricDetailResponse {
-  /** 成功时返回导入记录 ID，失败时则为 null */
-  import_record_id?: string
-}
-
-export interface QueryPerformanceV1ReviewDataResponse {
-  /** 绩效评估周期列表 */
-  semesters?: Semester[]
-  /** 绩效评估项目列表 */
-  activities?: Activity[]
-  /** 评估项列表 */
-  indicators?: Indicator[]
-  /** 评估模板列表 */
-  templates?: Template[]
-  /** 评估内容列表 */
-  units?: Unit[]
-  /** 填写项列表 */
-  fields?: Field[]
-  /** 评估数据列表 */
-  datas?: ReviewProfile[]
-}
-
 export interface QueryPerformanceV2ReviewDataResponse {
   /** 评估数据列表 */
   datas?: ReviewProfile[]

package/src/types/personal_settings.ts

@@ -51,6 +51,11 @@ export interface CreatePersonalSettingsSystemStatusRequest {
   sync_setting?: SystemStatusSyncSetting
 }
 
+export interface CreatePersonalSettingsSystemStatusResponse {
+  /** 系统状态 */
+  system_status?: SystemStatus
+}
+
 export interface PatchPersonalSettingsSystemStatusRequest {
   /** 系统状态 */
   system_status: SystemStatus
@@ -58,6 +63,11 @@ export interface PatchPersonalSettingsSystemStatusRequest {
   update_fields: ('TITLE' | 'I18N_TITLE' | 'ICON' | 'COLOR' | 'PRIORITY' | 'SYNC_SETTING')[]
 }
 
+export interface PatchPersonalSettingsSystemStatusResponse {
+  /** 系统状态 */
+  system_status?: SystemStatus
+}
+
 export interface BatchOpenPersonalSettingsSystemStatusRequest {
   /** 开启列表 */
   user_list: SystemStatusUserOpenParam[]
@@ -68,6 +78,11 @@ export interface BatchOpenPersonalSettingsSystemStatusQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface BatchOpenPersonalSettingsSystemStatusResponse {
+  /** 开启结果 */
+  result_list: SystemStatusUserOpenResultEntity[]
+}
+
 export interface BatchClosePersonalSettingsSystemStatusRequest {
   /** 成员列表 */
   user_list: string[]
@@ -78,21 +93,6 @@ export interface BatchClosePersonalSettingsSystemStatusQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
-export interface CreatePersonalSettingsSystemStatusResponse {
-  /** 系统状态 */
-  system_status?: SystemStatus
-}
-
-export interface PatchPersonalSettingsSystemStatusResponse {
-  /** 系统状态 */
-  system_status?: SystemStatus
-}
-
-export interface BatchOpenPersonalSettingsSystemStatusResponse {
-  /** 开启结果 */
-  result_list: SystemStatusUserOpenResultEntity[]
-}
-
 export interface BatchClosePersonalSettingsSystemStatusResponse {
   /** 关闭结果 */
   result_list: SystemStatusUserCloseResultEntity[]

package/src/types/report.ts

@@ -21,15 +21,27 @@ declare module '../internal' {
   }
 }
 
+export const enum QueryReportRuleQueryIncludeDeleted {
+  /** 不包括已删除 */
+  Exclude = 0,
+  /** 包括已删除 */
+  Include = 1,
+}
+
 export interface QueryReportRuleQuery {
   /** 规则名称 */
   rule_name: string
   /** 是否包括已删除，默认未删除 */
-  include_deleted?: 0 | 1
+  include_deleted?: QueryReportRuleQueryIncludeDeleted
   /** 此次调用中使用的用户ID的类型 */
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
+export interface QueryReportRuleResponse {
+  /** 规则列表 */
+  rules?: Rule[]
+}
+
 export interface RemoveReportRuleViewRequest {
   /** 列表为空删除规则下全用户视图，列表不为空删除指定用户视图，大小限制200。 */
   user_ids?: string[]
@@ -59,11 +71,6 @@ export interface QueryReportTaskQuery {
   user_id_type?: 'user_id' | 'union_id' | 'open_id'
 }
 
-export interface QueryReportRuleResponse {
-  /** 规则列表 */
-  rules?: Rule[]
-}
-
 Internal.define({
   '/report/v1/rules/query': {
     GET: 'queryReportRule',